1dat_ep_query(3DAT) Direct Access Transport Library Functionsdat_ep_query(3DAT)
2
3
4

NAME

6       dat_ep_query - provide parameters of the Endpoint
7

SYNOPSIS

9       cc [ flag... ] file... -ldat [ library... ]
10       #include <dat/udat.h>
11
12       DAT_RETURN
13           dat_ep_query (
14           IN    DAT_EP_HANDLE        ep_handle,
15           IN    DAT_EP_PARAM_MASK    ep_param_mask,
16           OUT   DAT_EP_PARAM         *ep_param
17           )
18
19

PARAMETERS

21       ep_handle        Handle for an instance of the Endpoint.
22
23
24       ep_param_mask    Mask for Endpoint parameters.
25
26
27       ep_param         Pointer  to  a  Consumer-allocated  structure that the
28                        Provider fills with Endpoint parameters.
29
30

DESCRIPTION

32       The dat_ep_query() function provides the Consumer parameters, including
33       attributes  and status, of the Endpoint. Consumers pass in a pointer to
34       Consumer-allocated structures for Endpoint parameters that the Provider
35       fills.
36
37
38       The  ep_param_mask  parameter allows Consumers to specify which parame‐
39       ters to query. The Provider returns values for ep_param_mask  requested
40       parameters. The Provider can return values for any other parameters.
41
42
43       Some  of  the  parameters only have values for certain Endpoint states.
44       Specifically, the values for remote_ia_address and remote_port_qual are
45       valid  only  for Endpoints in the DAT_EP_STATE_PASSIVE_CONNECTION_PEND‐
46       ING,    DAT_EP_STATE_ACTIVE_CONNECTION_PENDING,     DAT_EP_STATE_TENTA‐
47       TIVE_CONNECTION_PENDING,               DAT_EP_STATE_DISCONNECT_PENDING,
48       DAT_EP_STATE_COMPLETION_PENDING, or DAT_EP_STATE_CONNECTED states.  The
49       values   of   local_port_qual  is  valid  only  for  Endpoints  in  the
50       DAT_EP_STATE_PASSIVE_CONNECTION_PENDING,    DAT_EP_STATE_ACTIVE_CONNEC‐
51       TION_PENDING,   DAT_EP_STATE_DISCONNECT_PENDING,   DAT_EP_STATE_COMPLE‐
52       TION_PENDING, or DAT_EP_STATE_CONNECTED states, and might be valid  for
53       DAT_EP_STATE_UNCONNECTED,   DAT_EP_STATE_RESERVED,  DAT_EP_STATE_TENTA‐
54       TIVE_CONNECTION_PENDING,  DAT_EP_STATE_PASSIVE_CONNECTION_PENDING,  and
55       DAT_EP_STATE_UNCONNECTED states.
56

RETURN VALUES

58       DAT_SUCCESS              The operation was successful.
59
60
61       DAT_INVALID_HANDLE       The ep_handle parameter is invalid.
62
63
64       DAT_INVALID_PARAMETER    The ep_param_mask parameter is invalid.
65
66

ATTRIBUTES

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

SEE ALSO

82       libdat(3LIB), attributes(5)
83
84
85
86SunOS 5.11                        16 Jul 2004               dat_ep_query(3DAT)