DAT_SRQ_FREE(3DAT) Direct Access Transport Library Functions
dat_srq_free - destroy an instance of the shared receive queue
cc [ flag... ] file... -ldat [ library... ]
#include <dat/udat.h>
DAT_RETURN
dat_srq_free (
IN DAT_SRQ_HANDLE srq_handle
)
srq_handle
A handle for an instance of SRQ to be destroyed.
The dat_srq_free() function destroys an instance of the SRQ. The SRQ
cannot be destroyed if it is in use by an EP.
It is illegal to use the destroyed handle in any consequent
operation.
DAT_SUCCESS
The operation was successful.
DAT_INVALID_HANDLE
The srq_handle argument is an invalid DAT
handle.
DAT_SRQ_IN_USE
The Shared Receive Queue can not be destroyed
because it is in still associated with an EP
instance.
If the Provider detects the use of a deleted object handle, it should
return DAT_INVALID_HANDLE. The Provider should avoid assigning the
used handle as long as possible. Once reassigned the handle is no
longer a handle of a destroyed object.
See attributes(7) for descriptions of the following attributes:
+--------------------+----------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+----------------------+
|Interface Stability | Standard: uDAPL, 1.2 |
+--------------------+----------------------+
|MT-Level | Unsafe |
+--------------------+----------------------+
dat_srq_create(3DAT), dat_srq_post_recv(3DAT), dat_srq_query(3DAT),
dat_srq_resize(3DAT), dat_srq_set_lw(3DAT), libdat(3LIB),
attributes(7)
July 16, 2004 DAT_SRQ_FREE(3DAT)
NAME
dat_srq_free - destroy an instance of the shared receive queue
SYNOPSIS
cc [ flag... ] file... -ldat [ library... ]
#include <dat/udat.h>
DAT_RETURN
dat_srq_free (
IN DAT_SRQ_HANDLE srq_handle
)
PARAMETERS
srq_handle
A handle for an instance of SRQ to be destroyed.
DESCRIPTION
The dat_srq_free() function destroys an instance of the SRQ. The SRQ
cannot be destroyed if it is in use by an EP.
It is illegal to use the destroyed handle in any consequent
operation.
RETURN VALUES
DAT_SUCCESS
The operation was successful.
DAT_INVALID_HANDLE
The srq_handle argument is an invalid DAT
handle.
DAT_SRQ_IN_USE
The Shared Receive Queue can not be destroyed
because it is in still associated with an EP
instance.
USAGE
If the Provider detects the use of a deleted object handle, it should
return DAT_INVALID_HANDLE. The Provider should avoid assigning the
used handle as long as possible. Once reassigned the handle is no
longer a handle of a destroyed object.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+----------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+----------------------+
|Interface Stability | Standard: uDAPL, 1.2 |
+--------------------+----------------------+
|MT-Level | Unsafe |
+--------------------+----------------------+
SEE ALSO
dat_srq_create(3DAT), dat_srq_post_recv(3DAT), dat_srq_query(3DAT),
dat_srq_resize(3DAT), dat_srq_set_lw(3DAT), libdat(3LIB),
attributes(7)
July 16, 2004 DAT_SRQ_FREE(3DAT)