dat_evd_free(3dat)

1dat_evd_free(3DAT) Direct Access Transport Library Functionsdat_evd_free(3DAT)
2
3
4

NAME

6       dat_evd_free - destroy an instance of the Event Dispatcher
7

SYNOPSIS

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

PARAMETERS

19       evd_handle    Handle for an instance of the Event Dispatcher.
20
21

DESCRIPTION

23       The  dat_evd_free() function destroys a specified instance of the Event
24       Dispatcher.
25
26
27       All events on the queue of the specified Event Dispatcher are lost. The
28       destruction  of  the Event Dispatcher instance does not have any effect
29       on any DAT Objects that originated an Event Stream that had fed  events
30       to  the  Event  Dispatcher  instance.  There should be no event streams
31       feeding the Event Dispatcher and no threads blocked on the  Event  Dis‐
32       patcher  when  the  EVD is being closed as at the time when it was cre‐
33       ated.
34
35
36       Use of the handle of the destroyed Event Dispatcher in  any  consequent
37       operation fails.
38

RETURN VALUES

40       DAT_SUCCESS           The operation was successful.
41
42
43       DAT_INVALID_HANDLE    The evd_handle parameter is invalid
44
45
46       DAT_INVALID_STATE     Invalid  parameter. There are Event Streams asso‐
47                             ciated with the Event Dispatcher feeding it.
48
49

USAGE

51       Consumers are advised to  destroy  all  Objects  that  originate  Event
52       Streams that feed an instance of the Event Dispatcher before destroying
53       it. An exception to this rule is Event Dispatchers of an IA.
54
55
56       Freeing an IA automatically destroys all  Objects  associated  with  it
57       directly and indirectly, including Event Dispatchers.
58

ATTRIBUTES

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