usr/src/man/man3dat/dat_ep_disconnect.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_DISCONNECT 3DAT "April 9, 2016"
   8 .SH NAME
   9 dat_ep_disconnect \- terminate a connection or a connection establishment
  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_disconnect (
  18     IN    DAT_EP_HANDLE      ep_handle,
  19     IN    DAT_CLOSE_FLAGS    disconnect_flags
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .ne 2
  25 .na
  26 \fB\fIep_handle\fR\fR
  27 .ad
  28 .RS 20n
  29 Handle for an instance of Endpoint.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIdisconnect_flags\fR\fR
  36 .ad
  37 .RS 20n
  38 Flags for disconnect. Flag values are as follows:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBDAT_CLOSE_ABRUPT_FLAG\fR\fR
  43 .ad
  44 .RS 27n
  45 Abrupt close. This is the default value.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBDAT_CLOSE_GRACEFUL_FLAG\fR\fR
  52 .ad
  53 .RS 27n
  54 Graceful close.
  55 .RE
  56
  57 .RE
  58
  59 .SH DESCRIPTION
  60 .LP
  61 The \fBdat_ep_disconnect()\fR function requests a termination of a connection
  62 or connection establishment. This operation is used by the active/client or a
  63 passive/server side Consumer of the connection model.
  64 .sp
  65 .LP
  66 The \fIdisconnect_flags\fR parameter allows Consumers to specify whether they
  67 want graceful or abrupt disconnect. Upon disconnect, all outstanding and
  68 in-progress DTOs and RMR Binds must be completed.
  69 .sp
  70 .LP
  71 For abrupt disconnect, all outstanding DTOs and RMR Binds are completed
  72 unsuccessfully, and in-progress DTOs and RMR Binds can be completed
  73 successfully or unsuccessfully. If an in-progress DTO is completed
  74 unsuccessfully, all follow on in-progress DTOs in the same direction also must
  75 be completed unsuccessfully. This order is presented to the Consumer through a
  76 DTO completion Event Stream of the \fIrecv_evd_handle\fR and
  77 \fIrequest_evd_handle\fR of the Endpoint.
  78 .sp
  79 .LP
  80 For graceful disconnect, all outstanding and in-progress request DTOs and RMR
  81 Binds must try to be completed successfully first, before disconnect proceeds.
  82 During that time, the local Endpoint is in a \fBDAT_EP_DISCONNECT_PENDING\fR
  83 state.
  84 .sp
  85 .LP
  86 The Consumer can call abrupt \fBdat_ep_disconnect()\fR when the local Endpoint
  87 is in the \fBDAT_EP_DISCONNECT_PENDING\fR state. This causes the Endpoint to
  88 transition into \fBDAT_EP_STATE_DISCONNECTED\fR without waiting for outstanding
  89 and in-progress request DTOs and RMR Binds to successfully complete. The
  90 graceful \fBdat_ep_disconnect()\fR call when the local Endpoint is in the
  91 \fBDAT_EP_DISCONNECT_PENDING\fR state has no effect.
  92 .sp
  93 .LP
  94 If the Endpoint is not in \fBDAT_EP_STATE_CONNECTED\fR, the semantic of the
  95 operation is the same for graceful or abrupt \fIdisconnect_flags\fR value.
  96 .sp
  97 .LP
  98 No new Send, RDMA Read, and RDMA Write DTOs, or RMR Binds can be posted to the
  99 Endpoint when the local Endpoint is in the \fBDAT_EP_DISCONNECT_PENDING\fR
 100 state.
 101 .sp
 102 .LP
 103 The successful completion of the disconnect is reported to the Consumer through
 104 a \fBDAT_CONNECTION_EVENT_DISCONNECTED\fR event on \fIconnect_evd_handle\fR of
 105 the Endpoint. The Endpoint is automatically transitioned into a
 106 \fBDAT_EP_STATE_DISCONNECTED\fR state upon successful asynchronous completion.
 107 If the same EVD is used for \fIconnect_evd_handle\fR and any
 108 \fIrecv_evd_handle\fR and request_evd_handle, all successful Completion events
 109 of in-progress DTOs precede the Disconnect Completion event.
 110 .sp
 111 .LP
 112 Disconnecting an unconnected Disconnected Endpoint is no-op. Disconnecting an
 113 Endpoint in \fBDAT_EP_STATE_UNCONNECTED\fR, \fBDAT_EP_STATE_RESERVED\fR,
 114 \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, and
 115 \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR is disallowed.
 116 .sp
 117 .LP
 118 Both abrupt and graceful disconnect of the Endpoint during connection
 119 establishment, \fBDAT_EP_STATE_ACTIVE_CONNECTION_PENDING\fR and
 120 \fBDAT_EP_STATE_COMPLETION_PENDING\fR, "aborts" the connection establishment
 121 and transitions the local Endpoint into \fBDAT_EP_STATE_DISCONNECTED\fR. That
 122 causes preposted Recv DTOs to be flushed to \fIrecv_evd_handle\fR.
 123 .SH RETURN VALUES
 124 .ne 2
 125 .na
 126 \fB\fBDAT_SUCCESS\fR\fR
 127 .ad
 128 .RS 30n
 129 The operation was successful.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBDAT_INVALID_HANDLE\fR\fR
 136 .ad
 137 .RS 30n
 138 The \fIep_handle\fR parameter is invalid.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
 145 .ad
 146 .RS 30n
 147 The operation failed due to resource limitations.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 154 .ad
 155 .RS 30n
 156 The \fIdisconnect_flags\fR parameter is invalid.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBDAT_INVALID_STATE\fR\fR
 163 .ad
 164 .RS 30n
 165 A parameter is in an invalid state. Endpoint is not in the valid state for
 166 disconnect.
 167 .RE
 168
 169 .SH ATTRIBUTES
 170 .LP
 171 See \fBattributes\fR(5) for descriptions of the following attributes:
 172 .sp
 173
 174 .sp
 175 .TS
 176 box;
 177 c | c
 178 l | l .
 179 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 180 _
 181 Interface Stability     Standard: uDAPL, 1.1, 1.2
 182 _
 183 MT-Level         Unsafe
 184 .TE
 185
 186 .SH SEE ALSO
 187 .LP
 188 \fBlibdat\fR(3LIB), \fBattributes\fR(5)