dat_ep_reset(3dat)

1dat_ep_reset(3DAT) Direct Access Transport Library Functionsdat_ep_reset(3DAT)
2
3
4

NAME

6       dat_ep_reset  - transition the local Endpoint from a Disconnected to an
7       Unconnected state
8

SYNOPSIS

10       cc [ flag... ] file... -ldat [ library... ]
11       #include <dat/udat.h>
12
13       DAT_RETURN
14           dat_ep_reset (
15           IN    DAT_EP_HANDLE    ep_handle
16           )
17
18

PARAMETERS

20       ep_handle    Handle for an instance of Endpoint.
21
22

DESCRIPTION

24       The dat_ep_reset() function transitions the local Endpoint from a  Dis‐
25       connected to an Unconnected state.
26
27
28       The  operation  might  cause  the loss of any completions of previously
29       posted DTOs and RMRs that were not dequeued yet.
30
31
32       The dat_ep_reset() function is valid for both Disconnected  and  Uncon‐
33       nected  states.  For  Unconnected state, the operation is no-op because
34       the Endpoint is already in an Unconnected  state.  For  an  Unconnected
35       state, the preposted Recvs are not affected by the call.
36

RETURN VALUES

38       DAT_SUCCESS           The operation was successful.
39
40
41       DAT_INVALID_HANDLE    ep_handle is invalid.
42
43
44       DAT_INVALID_STATE     Parameter in an invalid state. Endpoint is not in
45                             the valid state for reset.
46
47

USAGE

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

ATTRIBUTES

58       See attributes(5) for descriptions of the following attributes:
59
60
61
62
63       ┌─────────────────────────────┬─────────────────────────────┐
64       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
65       ├─────────────────────────────┼─────────────────────────────┤
66       │Interface Stability          │Standard: uDAPL, 1.1, 1.2    │
67       ├─────────────────────────────┼─────────────────────────────┤
68       │MT-Level                     │Unsafe                       │
69       └─────────────────────────────┴─────────────────────────────┘
70