DAT_EP_QUERY(3DAT) Direct Access Transport Library Functions

NAME

dat_ep_query - provide parameters of the Endpoint

SYNOPSIS

cc [ flag... ] file... -ldat [ library... ]
#include <dat/udat.h>

DAT_RETURN
dat_ep_query (
IN DAT_EP_HANDLE ep_handle,
IN DAT_EP_PARAM_MASK ep_param_mask,
OUT DAT_EP_PARAM *ep_param
)

PARAMETERS

ep_handle
Handle for an instance of the Endpoint.


ep_param_mask
Mask for Endpoint parameters.


ep_param
Pointer to a Consumer-allocated structure that the
Provider fills with Endpoint parameters.

DESCRIPTION

The dat_ep_query() function provides the Consumer parameters,
including attributes and status, of the Endpoint. Consumers pass in a
pointer to Consumer-allocated structures for Endpoint parameters that
the Provider fills.


The ep_param_mask parameter allows Consumers to specify which
parameters to query. The Provider returns values for ep_param_mask
requested parameters. The Provider can return values for any other
parameters.


Some of the parameters only have values for certain Endpoint states.
Specifically, the values for remote_ia_address and remote_port_qual
are valid only for Endpoints in the
DAT_EP_STATE_PASSIVE_CONNECTION_PENDING,
DAT_EP_STATE_ACTIVE_CONNECTION_PENDING,
DAT_EP_STATE_TENTATIVE_CONNECTION_PENDING,
DAT_EP_STATE_DISCONNECT_PENDING, DAT_EP_STATE_COMPLETION_PENDING, or
DAT_EP_STATE_CONNECTED states. The values of local_port_qual is valid
only for Endpoints in the DAT_EP_STATE_PASSIVE_CONNECTION_PENDING,
DAT_EP_STATE_ACTIVE_CONNECTION_PENDING,
DAT_EP_STATE_DISCONNECT_PENDING, DAT_EP_STATE_COMPLETION_PENDING, or
DAT_EP_STATE_CONNECTED states, and might be valid for
DAT_EP_STATE_UNCONNECTED, DAT_EP_STATE_RESERVED,
DAT_EP_STATE_TENTATIVE_CONNECTION_PENDING,
DAT_EP_STATE_PASSIVE_CONNECTION_PENDING, and DAT_EP_STATE_UNCONNECTED
states.

RETURN VALUES

DAT_SUCCESS
The operation was successful.


DAT_INVALID_HANDLE
The ep_handle parameter is invalid.


DAT_INVALID_PARAMETER
The ep_param_mask parameter is invalid.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+---------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+---------------------------+
|Interface Stability | Standard: uDAPL, 1.1, 1.2 |
+--------------------+---------------------------+
|MT-Level | Unsafe |
+--------------------+---------------------------+

SEE ALSO

libdat(3LIB), attributes(7)

July 16, 2004 DAT_EP_QUERY(3DAT)