share/man/man3dat/dat_ep_query.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH DAT_EP_QUERY 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_ep_query \- provide parameters of the Endpoint
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_ep_query (
  18     IN    DAT_EP_HANDLE        ep_handle,
  19     IN    DAT_EP_PARAM_MASK    ep_param_mask,
  20     OUT   DAT_EP_PARAM         *ep_param
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIep_handle\fR\fR
  29 .ad
  30 .RS 17n
  31 Handle for an instance of the Endpoint.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIep_param_mask\fR\fR
  38 .ad
  39 .RS 17n
  40 Mask for Endpoint parameters.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIep_param\fR\fR
  47 .ad
  48 .RS 17n
  49 Pointer to a Consumer-allocated structure that the Provider fills with Endpoint
  50 parameters.
  51 .RE
  52
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 The \fBdat_ep_query()\fR function provides the Consumer parameters, including
  57 attributes and status, of the Endpoint. Consumers pass in a pointer to
  58 Consumer-allocated structures for Endpoint parameters that the Provider fills.
  59 .sp
  60 .LP
  61 The \fIep_param_mask\fR parameter allows Consumers to specify which parameters
  62 to query. The Provider returns values for \fIep_param_mask\fR requested
  63 parameters. The Provider can return values for any other parameters.
  64 .sp
  65 .LP
  66 Some of the parameters only have values for certain Endpoint states.
  67 Specifically, the values for \fIremote_ia_address\fR and \fIremote_port_qual\fR
  68 are valid only for Endpoints in the
  69 \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR,
  70 \fBDAT_EP_STATE_ACTIVE_CONNECTION_PENDING\fR,
  71 \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR,
  72 \fBDAT_EP_STATE_DISCONNECT_PENDING\fR, \fBDAT_EP_STATE_COMPLETION_PENDING\fR,
  73 or \fBDAT_EP_STATE_CONNECTED\fR states. The values of \fIlocal_port_qual\fR is
  74 valid only for Endpoints in the \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR,
  75 \fBDAT_EP_STATE_ACTIVE_CONNECTION_PENDING\fR,
  76 \fBDAT_EP_STATE_DISCONNECT_PENDING\fR, \fBDAT_EP_STATE_COMPLETION_PENDING\fR,
  77 or \fBDAT_EP_STATE_CONNECTED\fR states, and might be valid for
  78 \fBDAT_EP_STATE_UNCONNECTED\fR, \fBDAT_EP_STATE_RESERVED\fR,
  79 \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR,
  80 \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, and
  81 \fBDAT_EP_STATE_UNCONNECTED\fR states.
  82 .SH RETURN VALUES
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBDAT_SUCCESS\fR\fR
  87 .ad
  88 .RS 25n
  89 The operation was successful.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBDAT_INVALID_HANDLE\fR\fR
  96 .ad
  97 .RS 25n
  98 The \fIep_handle\fR parameter is invalid.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 105 .ad
 106 .RS 25n
 107 The \fIep_param_mask\fR parameter is invalid.
 108 .RE
 109
 110 .SH ATTRIBUTES
 111 .sp
 112 .LP
 113 See \fBattributes\fR(5) for descriptions of the following attributes:
 114 .sp
 115
 116 .sp
 117 .TS
 118 box;
 119 c | c
 120 l | l .
 121 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 122 _
 123 Interface Stability     Standard: uDAPL, 1.1, 1.2
 124 _
 125 MT-Level        Unsafe
 126 .TE
 127
 128 .SH SEE ALSO
 129 .sp
 130 .LP
 131 \fBlibdat\fR(3LIB), \fBattributes\fR(5)