share/man/man3dat/dat_psp_create_any.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_PSP_CREATE_ANY 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_psp_create_any \- create a persistent Public 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_psp_create_any(
  18     IN    DAT_IA_HANDLE    \fIia_handle\fR,
  19     IN    DAT_CONN_QUAL    \fIconn_qual\fR,
  20     IN    DAT_EVD_HANDLE   \fIevd_handle\fR,
  21     IN    DAT_PSP_FLAGS    \fIpsp_flags\fR,
  22     OUT   DAT_PSP_HANDLE   *\fIpsp_handle\fR
  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 on which the Public Service Point is listening.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIevd_handle\fR\fR
  49 .ad
  50 .RS 14n
  51 Event Dispatcher that provides the Connection Requested Events to the Consumer.
  52 The size of the event queue for the Event Dispatcher controls the size of the
  53 backlog for the created Public Service Point.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIpsp_flags\fR\fR
  60 .ad
  61 .RS 14n
  62 Flag that indicates whether the Provider or Consumer creates an Endpoint per
  63 arrived Connection Request. The value of \fBDAT_PSP_PROVIDER\fR indicates that
  64 the Consumer wants to get an Endpoint from the Provider; a value of
  65 \fBDAT_PSP_CONSUMER\fR means the Consumer does not want the Provider to provide
  66 an Endpoint for each arrived Connection Request.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fIpsp_handle\fR\fR
  73 .ad
  74 .RS 14n
  75 Handle to an opaque Public Service Point.
  76 .RE
  77
  78 .SH DESCRIPTION
  79 .sp
  80 .LP
  81 The \fBdat_psp_create_any()\fR function creates a persistent Public Service
  82 Point that can receive multiple requests for connection and generate multiple
  83 Connection Request instances that are delivered through the specified Event
  84 Dispatcher in Notification events.
  85 .sp
  86 .LP
  87 The \fBdat_psp_create_any()\fR function allocates an unused Connection
  88 Qualifier, creates a Public Service point for it, and returns both the
  89 allocated Connection Qualifier and the created Public Service Point to the
  90 Consumer.
  91 .sp
  92 .LP
  93 The allocated Connection Qualifier should be chosen from "nonprivileged" ports
  94 that are not currently used or reserved by any user or kernel Consumer or host
  95 ULP of the IA. The format of allocated Connection Qualifier returned is
  96 specific to IA transport type.
  97 .sp
  98 .LP
  99 The \fBdat_psp_create_any()\fR function is blocking. When the Public Service
 100 Point is created, \fBDAT_SUCCESS\fR is returned, \fIpsp_handle\fR contains a
 101 handle to an opaque Public Service Point Object, and \fIconn_qual\fR contains
 102 the allocated Connection Qualifier. When return is not \fBDAT_SUCCESS\fR,
 103 \fIpsp_handle\fR and \fIconn_qual\fR return values are undefined.
 104 .sp
 105 .LP
 106 There is no explicit backlog for a Public Service Point. Instead, Consumers can
 107 control the size of backlog through the queue size of the associated Event
 108 Dispatcher.
 109 .sp
 110 .LP
 111 The \fIpsp_flags\fR parameter allows Consumers to request that the Provider
 112 create an implicit Endpoint for each incoming Connection Request, or request
 113 that the Provider should not create one per Connection Request. If the Provider
 114 cannot satisfy the request, the operation shall fail and
 115 \fBDAT_MODEL_NOT_SUPPORTED\fR is returned.
 116 .sp
 117 .LP
 118 All Endpoints created by the Provider have \fBDAT_HANDLE_NULL\fR  for the
 119 Protection Zone and all Event Dispatchers. The Provider sets up Endpoint
 120 attributes to match the Active side connection request. The Consumer can change
 121 Endpoint parameters. Consumers should change Endpoint parameters, especially PZ
 122 and EVD, and are advised to change parameters for local accesses prior to the
 123 connection request acceptance with the Endpoint.
 124 .SH RETURN VALUES
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBDAT_SUCCESS\fR\fR
 129 .ad
 130 .RS 30n
 131 The operation was successful.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
 138 .ad
 139 .RS 30n
 140 The operation failed due to resource limitations.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBDAT_INVALID_HANDLE\fR\fR
 147 .ad
 148 .RS 30n
 149 The \fIia_handle\fR or \fIevd_handle\fR parameter is invalid.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 156 .ad
 157 .RS 30n
 158 The \fIconn_qual\fR or \fIpsp_flags\fR parameter is invalid.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBDAT_CONN_QUAL_UNAVAILABLE\fR\fR
 165 .ad
 166 .RS 30n
 167 No Connection Qualifiers available.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBDAT_MODEL_NOT_SUPPORTED\fR\fR
 174 .ad
 175 .RS 30n
 176 The requested Model was not supported by the Provider.
 177 .RE
 178
 179 .SH ATTRIBUTES
 180 .sp
 181 .LP
 182 See \fBattributes\fR(5) for descriptions of the following attributes:
 183 .sp
 184
 185 .sp
 186 .TS
 187 box;
 188 c | c
 189 l | l .
 190 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 191 _
 192 Interface Stability     Standard: uDAPL, 1.1, 1.2
 193 _
 194 MT-Level        Safe
 195 .TE
 196
 197 .SH SEE ALSO
 198 .sp
 199 .LP
 200 \fBlibdat\fR(3LIB), \fBattributes\fR(5)