man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: July 2014
 
 

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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard
uDAPL, 1.2

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(5)