usr/src/man/man3dat/dat_rsp_free.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_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_rsp_free \- destroy an instance of the 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_free (
  18     IN    DAT_RSP_HANDLE    rsp_handle
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIrsp_handle\fR\fR
  27 .ad
  28 .RS 14n
  29 Handle for an instance of the Reserved Service Point.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_rsp_free()\fR function destroys a specified instance of the Reserved
  36 Service Point.
  37 .sp
  38 .LP
  39 Any incoming Connection Requests for the Connection Qualifier on the destroyed
  40 Service Point was listening on are automatically rejected by the Provider with
  41 the return analogous to the no listening Service Point.
  42 .sp
  43 .LP
  44 The behavior of the Connection Requests in progress is undefined and left to an
  45 implementation, but it must be consistent. This means that either a Connection
  46 Requested Event was generated for the Event Dispatcher associated with the
  47 Service Point, including the creation of the Connection Request instance, or
  48 the Connection Request is rejected by the Provider without any local
  49 notification.
  50 .sp
  51 .LP
  52 This operation has no effect on previously generated Connection Request Event
  53 and Connection Request.
  54 .sp
  55 .LP
  56 The behavior of this operation with creation of a Service Point on the same
  57 Connection Qualifier at the same time is not defined. Consumers are advised to
  58 avoid this scenario.
  59 .sp
  60 .LP
  61 For the Reserved Service Point, the Consumer-provided Endpoint reverts to
  62 Consumer control. Consumers shall be aware that due to a race condition, this
  63 Reserved Service Point might have generated a Connection Request Event and
  64 passed the associated Endpoint to a Consumer in it.
  65 .sp
  66 .LP
  67 Use of the handle of the destroyed Service Point in any consequent operation
  68 fails.
  69 .SH RETURN VALUES
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBDAT_SUCCESS\fR\fR
  74 .ad
  75 .RS 22n
  76 The operation was successful.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBDAT_INVALID_HANDLE\fR\fR
  83 .ad
  84 .RS 22n
  85 The \fIrsp_handle\fR parameter is invalid.
  86 .RE
  87
  88 .SH ATTRIBUTES
  89 .sp
  90 .LP
  91 See \fBattributes\fR(5) for descriptions of the following attributes:
  92 .sp
  93
  94 .sp
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Standard: uDAPL, 1.1, 1.2
 102 _
 103 MT-Level        Unsafe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBlibdat\fR(3LIB), \fBattributes\fR(5)