usr/src/man/man3dat/dat_rsp_create.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_RSP_CREATE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_rsp_create \- create a Reserved Service Point
  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_rsp_create (
  18     IN    DAT_IA_HANDLE    ia_handle,
  19     IN    DAT_CONN_QUAL    conn_qual,
  20     IN    DAT_EP_HANDLE    ep_handle,
  21     IN    DAT_EVD_HANDLE   evd_handle,
  22     OUT   DAT_RSP_HANDLE   *rsp_handle
  23     )
  24 .fi
  25
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIia_handle\fR\fR
  31 .ad
  32 .RS 14n
  33 Handle for an instance of DAT IA.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIconn_qual\fR\fR
  40 .ad
  41 .RS 14n
  42 Connection Qualifier of the IA the Reserved Service Point listens to.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIep_handle\fR\fR
  49 .ad
  50 .RS 14n
  51 Handle for the Endpoint associated with the Reserved Service Point that is the
  52 only Endpoint that can accept a Connection Request on this Service Point. The
  53 value \fBDAT_HANDLE_NULL\fR requests the Provider to associate a
  54 Provider-created Endpoint with this Service Point.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIevd_handle\fR\fR
  61 .ad
  62 .RS 14n
  63 The Event Dispatcher to which an event of Connection Request arrival is
  64 generated.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fIrsp_handle\fR\fR
  71 .ad
  72 .RS 14n
  73 Handle to an opaque Reserved Service Point.
  74 .RE
  75
  76 .SH DESCRIPTION
  77 .sp
  78 .LP
  79 The \fBdat_rsp_create()\fR function creates a Reserved Service Point with the
  80 specified Endpoint that generates, at most, one Connection Request that is
  81 delivered to the specified Event Dispatcher in a Notification event.
  82 .SH RETURN VALUES
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBDAT_SUCCESS\fR\fR
  87 .ad
  88 .RS 30n
  89 The operation was successful.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  96 .ad
  97 .RS 30n
  98 The operation failed due to resource limitations.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBDAT_INVALID_HANDLE\fR\fR
 105 .ad
 106 .RS 30n
 107 The \fIia_handle\fR, \fIevd_handle\fR, or \fIep_handle\fR parameter is invalid.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 114 .ad
 115 .RS 30n
 116 The \fIconn_qual\fR parameter is invalid.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBDAT_INVALID_STATE\fR\fR
 123 .ad
 124 .RS 30n
 125 Parameter in an invalid state. For example, an Endpoint was not in the Idle
 126 state.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBDAT_CONN_QUAL_IN_USE\fR\fR
 133 .ad
 134 .RS 30n
 135 Specified Connection Qualifier is in use.
 136 .RE
 137
 138 .SH USAGE
 139 .sp
 140 .LP
 141 The usage of a Reserve Service Point is as follows:
 142 .RS +4
 143 .TP
 144 .ie t \(bu
 145 .el o
 146 The DAT Consumer creates a Local Endpoint and configures it appropriately.
 147 .RE
 148 .RS +4
 149 .TP
 150 .ie t \(bu
 151 .el o
 152 The DAT Consumer creates a Reserved Service Point specifying the Local
 153 Endpoint.
 154 .RE
 155 .RS +4
 156 .TP
 157 .ie t \(bu
 158 .el o
 159 The Reserved Service Point performs the following:
 160 .RS +4
 161 .TP
 162 .ie t \(bu
 163 .el o
 164 Collects native transport information reflecting a received Connection Request.
 165 .RE
 166 .RS +4
 167 .TP
 168 .ie t \(bu
 169 .el o
 170 Creates a Pending Connection Request.
 171 .RE
 172 .RS +4
 173 .TP
 174 .ie t \(bu
 175 .el o
 176 Creates a Connection Request Notice (event) that includes the Pending
 177 Connection Request (which includes, among others, Reserved Service Point
 178 Connection Qualifier, its Local Endpoint, and information about remote
 179 Endpoint).
 180 .RE
 181 .RS +4
 182 .TP
 183 .ie t \(bu
 184 .el o
 185 Delivers the Connection Request Notice to the Consumer-specified target (CNO)
 186 \fIevd_handle\fR. The Local Endpoint is transitioned from Reserved to Passive
 187 Connection Pending state.
 188 .RE
 189 .RE
 190 .RS +4
 191 .TP
 192 .ie t \(bu
 193 .el o
 194 Upon receiving a connection request, or at some time subsequent to that, the
 195 DAT Consumer must either \fBaccept()\fR or \fBreject()\fR the Pending
 196 Connection Request.
 197 .RE
 198 .RS +4
 199 .TP
 200 .ie t \(bu
 201 .el o
 202 If accepted, the original Local Endpoint is now in a \fBConnected\fR state and
 203 fully usable for this connection, pending only native transport mandated RTU
 204 messages. This includes binding it to the IA port if that was not done
 205 previously. The Consumer is notified that the Endpoint is in a \fBConnected\fR
 206 state by a Connection Established Event on the Endpoint
 207 \fIconnect_evd_handle\fR.
 208 .RE
 209 .RS +4
 210 .TP
 211 .ie t \(bu
 212 .el o
 213 If rejected, the Local Endpoint point transitions into \fBUnconnected\fR state.
 214 The DAT Consumer can elect to destroy it or reuse it for other purposes.
 215 .RE
 216 .SH ATTRIBUTES
 217 .sp
 218 .LP
 219 See \fBattributes\fR(5) for descriptions of the following attributes:
 220 .sp
 221
 222 .sp
 223 .TS
 224 box;
 225 c | c
 226 l | l .
 227 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 228 _
 229 Interface Stability     Standard: uDAPL, 1.1, 1.2
 230 _
 231 MT-Level        Safe
 232 .TE
 233
 234 .SH SEE ALSO
 235 .sp
 236 .LP
 237 \fBlibdat\fR(3LIB), \fBattributes\fR(5)