1dat_ep_get_status(3DDAiTr)ect Access Transport Library Functdiaotn_sep_get_status(3DAT)
2
3
4

NAME

6       dat_ep_get_status - provide a quick snapshot of the Endpoint
7

SYNOPSIS

9       cc [ flag... ] file... -ldat [ library... ]
10       #include <dat/udat.h>
11
12       DAT_RETURN
13           dat_ep_get_status (
14           IN    DAT_EP_HANDLE    ep_handle,
15           OUT   DAT_EP_STATE     *ep_state,
16           OUT   DAT_BOOLEAN      *recv_idle,
17           OUT   DAT_BOOLEAN      *request_idle
18           )
19
20

PARAMETERS

22       ep_handle       Handle for an instance of the Endpoint.
23
24
25       ep_state        Current state of the Endpoint.
26
27
28       recv_idle       Status of the incoming DTOs on the Endpoint.
29
30
31       request_idle    Status  of the outgoing DTOs and RMR Bind operations on
32                       the Endpoint.
33
34

DESCRIPTION

36       the dat_ep_get_status() function provides the Consumer a quick snapshot
37       of  the  Endpoint.  The  snapshot  consists  of  the Endpoint state and
38       whether there are outstanding  or  in-progress,  incoming  or  outgoing
39       DTOs.  Incoming  DTOs consist of Receives. Outgoing DTOs consist of the
40       Requests, Send, RDMA Read, RDMA Write, and RMR Bind.
41
42
43       The ep_state parameter returns the value of the current  state  of  the
44       Endpoint   ep_handle.   State   value   is   one   of   the  following:
45       DAT_EP_STATE_UNCONNECTED,   DAT_EP_STATE_RESERVED,    DAT_EP_STATE_PAS‐
46       SIVE_CONNECTION_PENDING,        DAT_EP_STATE_ACTIVE_CONNECTION_PENDING,
47       DAT_EP_STATE_TENTATIVE_CONNECTION_PENDING,      DAT_EP_STATE_CONNECTED,
48       DAT_EP_STATE_DISCONNECT_PENDING, or DAT_EP_STATE_DISCONNECTED.
49
50
51       A  recv_idle  value of DAT_TRUE specifies that there are no outstanding
52       or in-progress Receive DTOs at the Endpoint, and DAT_FALSE otherwise.
53
54
55       A request_idle value of DAT_TRUE specifies that there are no  outstand‐
56       ing  or in-progress Send, RDMA Read, and RDMA Write DTOs, and RMR Binds
57       at the Endpoint, and DAT_FALSE otherwise.
58
59
60       This call provides a snapshot of the Endpoint status  only.  No  heroic
61       synchronization with DTO queuing or processing is implied.
62

RETURN VALUES

64       DAT_SUCCESS           The operation was successful.
65
66
67       DAT_INVALID_HANDLE    The ep_handle parameter is invalid.
68
69

ATTRIBUTES

71       See attributes(5) for descriptions of the following attributes:
72
73
74
75
76       ┌─────────────────────────────┬─────────────────────────────┐
77       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
78       ├─────────────────────────────┼─────────────────────────────┤
79       │Interface Stability          │Standard: uDAPL, 1.1, 1.2    │
80       ├─────────────────────────────┼─────────────────────────────┤
81       │MT-Level                     │Safe                         │
82       └─────────────────────────────┴─────────────────────────────┘
83

SEE ALSO

85       libdat(3LIB), attributes(5)
86
87
88
89SunOS 5.11                        16 Jul 2004          dat_ep_get_status(3DAT)
Impressum