Current File : //usr/man/man3dat/dat_ep_get_status.3dat

'\" te
.\" This manual page is derived from the DAT/uDAPL 1.2 specification.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.TH dat_ep_get_status 3DAT "16 Jul 2004" "SunOS 5.11" "Direct Access Transport Library Functions"
.SH NAME
dat_ep_get_status \- provide a quick snapshot of the Endpoint
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_ep_get_status (
    IN    DAT_EP_HANDLE    ep_handle,
    OUT   DAT_EP_STATE     *ep_state,
    OUT   DAT_BOOLEAN      *recv_idle,
    OUT   DAT_BOOLEAN      *request_idle
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIep_handle\fR\fR
.ad
.RS 16n
.rt  
Handle for an instance of the Endpoint.
.RE

.sp
.ne 2
.mk
.na
\fB\fIep_state\fR\fR
.ad
.RS 16n
.rt  
Current state of the Endpoint.
.RE

.sp
.ne 2
.mk
.na
\fB\fIrecv_idle\fR\fR
.ad
.RS 16n
.rt  
Status of the incoming DTOs on the Endpoint. 
.RE

.sp
.ne 2
.mk
.na
\fB\fIrequest_idle\fR\fR
.ad
.RS 16n
.rt  
Status of the outgoing DTOs and RMR Bind operations on the Endpoint.
.RE

.SH DESCRIPTION
.sp
.LP
the \fBdat_ep_get_status()\fR function provides the Consumer a quick snapshot of the Endpoint. The snapshot consists of the Endpoint state and whether there are outstanding or in-progress, incoming or outgoing DTOs. Incoming DTOs consist of Receives. Outgoing DTOs consist of the Requests, Send, RDMA Read, RDMA Write, and RMR Bind.
.sp
.LP
The \fIep_state\fR parameter returns the value of the current state of the Endpoint \fIep_handle\fR. State value is one of the following: \fBDAT_EP_STATE_UNCONNECTED\fR, \fBDAT_EP_STATE_RESERVED\fR, \fBDAT_EP_STATE_PASSIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_ACTIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_TENTATIVE_CONNECTION_PENDING\fR, \fBDAT_EP_STATE_CONNECTED\fR, \fBDAT_EP_STATE_DISCONNECT_PENDING\fR, or \fBDAT_EP_STATE_DISCONNECTED\fR.
.sp
.LP
A \fIrecv_idle\fR value of \fBDAT_TRUE\fR specifies that there are no outstanding or in-progress Receive DTOs at the Endpoint, and \fBDAT_FALSE\fR otherwise.
.sp
.LP
A \fIrequest_idle\fR value of \fBDAT_TRUE\fR specifies that there are no outstanding or in-progress Send, RDMA Read, and RDMA Write DTOs, and RMR Binds at the Endpoint, and \fBDAT_FALSE\fR otherwise.
.sp
.LP
This call provides a snapshot of the Endpoint status only. No heroic synchronization with DTO queuing or processing is implied.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBDAT_SUCCESS\fR\fR
.ad
.RS 22n
.rt  
The operation was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDAT_INVALID_HANDLE\fR\fR
.ad
.RS 22n
.rt  
The \fIep_handle\fR parameter is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
_
StandarduDAPL, 1.1, 1.2
.TE

.SH SEE ALSO
.sp
.LP
\fBlibdat\fR(3LIB), \fBattributes\fR(5)