1dat_ep_free(3DAT)  Direct Access Transport Library Functions dat_ep_free(3DAT)
2
3
4

NAME

6       dat_ep_free - destroy an instance of the Endpoint
7

SYNOPSIS

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

PARAMETERS

19       ep_handle    Handle for an instance of the Endpoint.
20
21

DESCRIPTION

23       The dat_ep_free() function destroys an instance of the Endpoint.
24
25
26       The  Endpoint  can  be destroyed in any Endpoint state except Reserved,
27       Passive Connection  Pending,  and  Tentative  Connection  Pending.  The
28       destruction  of the Endpoint can also cause the destruction of DTOs and
29       RMRs posted to the Endpoint and not dequeued yet. This includes comple‐
30       tions  for all outstanding and in-progress DTOs/RMRs. The Consumer must
31       be ready for all completions that are not  dequeued  yet  either  still
32       being  on  the  Endpoint  recv_evd_handle and request_evd_handle or not
33       being there.
34
35
36       The destruction of the Endpoint during connection setup aborts  connec‐
37       tion establishment.
38
39
40       If  the  Endpoint  is  in  the Reserved state, the Consumer shall first
41       destroy the associated Reserved Service Point that transitions the End‐
42       point  into  the Unconnected state where the Endpoint can be destroyed.
43       If the Endpoint is in the Passive Connection Pending  state,  the  Con‐
44       sumer shall first reject the associated Connection Request that transi‐
45       tions the Endpoint into the Unconnected state where the Endpoint can be
46       destroyed.  If  the  Endpoint  is  in  the Tentative Connection Pending
47       state, the Consumer shall reject the associated Connection Request that
48       transitions  the Endpoint back to Provider control, and the Endpoint is
49       destroyed as far as the Consumer is concerned.
50
51
52       The freeing of an Endpoint also destroys an Event Stream  for  each  of
53       the associated Event Dispatchers.
54
55
56       Use of the handle of the destroyed Endpoint in any subsequent operation
57       except for the dat_ep_free() fails.
58

RETURN VALUES

60       DAT_SUCCESS           The operation was successful.
61
62
63       DAT_INVALID_HANDLE    The ep_handle parameter is invalid.
64
65
66       DAT_INVALID_STATE     Parameter in an invalid state. The Endpoint is in
67                             DAT_EP_STATE_RESERVED,  DAT_EP_STATE_PASSIVE_CON‐
68                             NECTION_PENDING,  or  DAT_EP_STATE_TENTATIVE_CON‐
69                             NECTION_PENDING.
70
71

ATTRIBUTES

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

SEE ALSO

87       libdat(3LIB), attributes(5)
88
89
90
91SunOS 5.11                        16 Jul 2004                dat_ep_free(3DAT)
Impressum