dat_ep_reset.3dat revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
This manual page is derived from the DAT/uDAPL 1.2 specification.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
dat_ep_reset 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
NAME
dat_ep_reset - transition the local Endpoint from a Disconnected to an Unconnected state
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -ldat [ library.\|.\|. ] 
#include <dat/udat.h>

DAT_RETURN
 dat_ep_reset (
 IN DAT_EP_HANDLE ep_handle
 )
PARAMETERS

ep_handle

Handle for an instance of Endpoint.

DESCRIPTION

The dat_ep_reset() function transitions the local Endpoint from a Disconnected to an Unconnected state.

The operation might cause the loss of any completions of previously posted DTOs and RMRs that were not dequeued yet.

The dat_ep_reset() function is valid for both Disconnected and Unconnected states. For Unconnected state, the operation is no-op because the Endpoint is already in an Unconnected state. For an Unconnected state, the preposted Recvs are not affected by the call.

RETURN VALUES

DAT_SUCCESS

The operation was successful.

DAT_INVALID_HANDLE

ep_handle is invalid.

DAT_INVALID_STATE

Parameter in an invalid state. Endpoint is not in the valid state for reset.

USAGE

If the Consumer wants to ensure that all Completions are dequeued, the Consumer can post DTO or RMR operations as a "marker" that are flushed to recv_evd_handle or request_evd_handle. Now, when the Consumer dequeues the completion of the "marker" from the EVD, it is guaranteed that all previously posted DTO and RMR completions for the Endpoint were dequeued for that EVD. Now, it is safe to reset the Endpoint without losing any completions.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard: uDAPL, 1.1, 1.2
MT-LevelUnsafe
SEE ALSO

libdat(3LIB), attributes(5)