dat_srq_query(3dat) [opensolaris man page]
dat_srq_query(3DAT) Direct Access Transport Library Functions dat_srq_query(3DAT) NAME
dat_srq_query - provide parameters of the shared receive queue SYNOPSIS
cc [ flag... ] file... -ldat [ library... ] #include <dat/udat.h> DAT_RETURN dat_srq_query ( IN DAT_SRQ_HANDLE srq_handle, IN DAT_SRQ_PARAM_MASK srq_param_mask, OUT DAT_SRQ_PARAM *srq_param ) PARAMETERS
srq_handle A handle for an instance of the SRQ. srq_param_mask The mask for SRQ parameters. srq_param A pointer to a Consumer-allocated structure that the Provider fills with SRQ parameters. DESCRIPTION
The dat_srq_query() function provides to the Consumer SRQ parameters. The Consumer passes a pointer to the Consumer-allocated structures for SRQ parameters that the Provider fills. The srq_param_mask argument allows Consumers to specify which parameters to query. The Provider returns values for the requested srq_param_mask parameters. The Provider can return values for any other parameters. In addition to the elements in SRQ attribute, dat_srq_query() provides additional information in the srq_param structure if Consumer requests it with srq_param_mask settings. The two that are related to entry counts on SRQ are the number of Receive buffers (avail- able_dto_count) available for EPs to dequeue and the number of occupied SRQ entries (outstanding_dto_count) not available for new Recv buf- fer postings. RETURN VALUES
DAT_SUCCESS The operation was successful. DAT_INVALID_PARAMETER The srq_param_mask argument is invalid. DAT_INVALID_HANDLE The srq_handle argument is an invalid DAT handle. USAGE
The Provider might not be able to provide the number of outstanding Recv of SRQ or available Recvs of SRQ. The Provider attribute indicates if the Provider does not support the query for one or these values. Even when the Provider supports the query for one or both of these val- ues, it might not be able to provide this value at this moment. In either case, the return value for the attribute that cannot be provided will be DAT_VALUE_UNKNOWN. Example: Consumer created SRQ with 10 entries and associated 1 EP with it. 3 Recv buffers have been posted to it. The query will report: max_recv_dtos=10, available_dto_count=3, outstanding_dto_count=3. After a Send message arrival the query will report: max_recv_dtos=10, available_dto_count=2, outstanding_dto_count=3. After Consumer dequeues Recv completion the query will report: max_recv_dtos=10, available_dto_count=2, outstanding_dto_count=2. In general, each EP associated with SRQ can have multiple buffers in progress of receiving messages as well completed Recv on EVDs. The watermark setting helps to control how many Recv buffers posted to SRQ an Endpoint can own. If the Provider cannot support the query for the number of outstanding Recv of SRQ or available Recvs of SRQ, the value return for that attribute should be DAT_VALUE_UNKNOWN. ATTRIBUTES
See attributes(5) 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_free(3DAT), dat_srq_post_recv(3DAT), dat_srq_resize(3DAT), dat_srq_set_lw(3DAT), libdat(3LIB), attributes(5) SunOS 5.11 16 Jul 2004 dat_srq_query(3DAT)
Check Out this Related Man Page
dat_ep_set_watermark(3DAT) Direct Access Transport Library Functions dat_ep_set_watermark(3DAT) NAME
dat_ep_set_watermark - set high watermark on Endpoint SYNOPSIS
cc [ flag... ] file... -ldat [ library... ] #include <dat/udat.h> DAT_RETURN dat_ep_set_watermark ( IN DAT_EP_HANDLE ep_handle, IN DAT_COUNT soft_high_watermark, IN DAT_COUNT hard_high_watermark ) PARAMETERS
ep_handle The handle for an instance of an Endpoint. soft_high_watermark The soft high watermark for the number of Recv buffers consumed by the Endpoint. hard_high_watermark The hard high watermark for the number of Recv buffers consumed by the Endpoint. DESCRIPTION
The dat_ep_set_watermark() function sets the soft and hard high watermark values for EP and arms EP for generating asynchronous events for high watermarks. An asynchronous event will be generated for IA async_evd when the number of Recv buffers at EP exceeds the soft high watermark for the first time. A connection broken event will be generated for EP connect_evd when the number of Recv buffers at EP exceeds the hard high watermark. These can occur during this call or when EP takes a buffer from the SRQ or EP RQ. The soft and hard high watermark asynchronous event generation and setting are independent of each other. The asynchronous event for a soft high watermark is generated only once per setting. Once an event is generated, no new asynchronous events for the soft high watermark is generated until the EP is again set for the soft high watermark. If the Consumer is once again interested in the event, the Consumer should again set the soft high watermark. If the Consumer is not interested in a soft or hard high watermark, the value of DAT_WATERMARK_INFINITE can be specified for the case that is the default value. This value specifies that a non-asynchronous event will be generated for a high watermark EP attribute for which this value is set. It does not prevent generation of a connection broken event for EP when no Recv buffer is available for a message arrived on the EP connection. The operation is supported for all states of Endpoint. RETURN VALUES
DAT_SUCCESS The operation was successful. DAT_INVALID_HANDLE The ep_handle argument is an invalid DAT handle. DAT_INVALID_PARAMETER One of the parameters is invalid. DAT_MODEL_NOT_SUPPORTED The requested Model was not supported by the Provider. The Provider does not support EP Soft or Hard High Watermarks. USAGE
For a hard high watermark, the Provider is ready to generate a connection broken event as soon as the connection is established. If the asynchronous event for a soft or hard high watermark has not yet been generated, this call simply modifies the values for these attributes. The Provider remains armed for generation of these asynchronous events. Regardless of whether an asynchronous event for the soft and hard high watermark has been generated, this operation will set the generation of an asynchronous event with the Consumer-provided high watermark values. If the new high watermark values are below the current number of Receive DTOs at EP, an asynchronous event will be generated immediately. Otherwise the old soft or hard (or both) high watermark values are simply replaced with the new ones. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard: uDAPL, 1.2 | +-----------------------------+-----------------------------+ |MT-Level |Unsafe | +-----------------------------+-----------------------------+ SEE ALSO
dat_ep_create(3DAT), dat_ep_recv_query(3DAT), dat_srq_create(3DAT), dat_srq_free(3DAT), dat_srq_post_recv(3DAT), dat_srq_query(3DAT), dat_srq_resize(3DAT), dat_srq_set_lw(3DAT), libdat(3LIB), attributes(5) SunOS 5.10 16 Jul 2004 dat_ep_set_watermark(3DAT)