usr/src/man/man3dat/dat_ep_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_EP_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_ep_free \- destroy an instance 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_free (
  18     IN    DAT_EP_HANDLE    ep_handle
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIep_handle\fR\fR
  27 .ad
  28 .RS 13n
  29 Handle for an instance of the Endpoint.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_ep_free()\fR function destroys an instance of the Endpoint.
  36 .sp
  37 .LP
  38 The Endpoint can be destroyed in any Endpoint state except Reserved, Passive
  39 Connection Pending, and Tentative Connection Pending. The destruction of the
  40 Endpoint can also cause the destruction of DTOs and RMRs posted to the Endpoint
  41 and not dequeued yet. This includes completions for all outstanding and
  42 in-progress DTOs/RMRs. The Consumer must be ready for all completions that are
  43 not dequeued yet either still being on the Endpoint \fIrecv_evd_handle\fR and
  44 \fIrequest_evd_handle\fR or not being there.
  45 .sp
  46 .LP
  47 The destruction of the Endpoint during connection setup aborts connection
  48 establishment.
  49 .sp
  50 .LP
  51 If the Endpoint is in the Reserved state, the Consumer shall first destroy the
  52 associated Reserved Service Point that transitions the Endpoint into the
  53 Unconnected state where the Endpoint can be destroyed. If the Endpoint is in
  54 the Passive Connection Pending state, the Consumer shall first reject the
  55 associated Connection Request that transitions the Endpoint into the
  56 Unconnected state where the Endpoint can be destroyed. If the Endpoint is in
  57 the Tentative Connection Pending state, the Consumer shall reject the
  58 associated Connection Request that transitions the Endpoint back to Provider
  59 control, and the Endpoint is destroyed as far as the Consumer is concerned.
  60 .sp
  61 .LP
  62 The freeing of an Endpoint also destroys an Event Stream for each of the
  63 associated Event Dispatchers.
  64 .sp
  65 .LP
  66 Use of the handle of the destroyed Endpoint in any subsequent operation except
  67 for the \fBdat_ep_free()\fR fails.
  68 .SH RETURN VALUES
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBDAT_SUCCESS\fR\fR
  73 .ad
  74 .RS 22n
  75 The operation was successful.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBDAT_INVALID_HANDLE\fR\fR
  82 .ad
  83 .RS 22n
  84 The \fIep_handle\fR parameter is invalid.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBDAT_INVALID_STATE\fR\fR
  91 .ad
  92 .RS 22n
  93 Parameter in an invalid state. The Endpoint is in \fBDAT_EP_STATE_RESERVED\fR,
  94 \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, or
  95 \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR.
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Standard: uDAPL, 1.1, 1.2
 112 _
 113 MT-Level        Unsafe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBlibdat\fR(3LIB), \fBattributes\fR(5)