tibrvQueue_GetLimitPolicy()

Function

Declaration

tibrv_status tibrvQueue_GetLimitPolicy(
    tibrvQueue                eventQueue,
    tibrvQueueLimitPolicy*    policy,
    tibrv_u32*                maxEvents,
    tibrv_u32*                discardAmount);

Purpose

Extract the limit properties of a queue.

Parameter	Description
`eventQueue`	Extract the limit information from this queue.
`policy`	Each queue has a policy for discarding events when a new event would cause the queue to exceed its `maxEvents` limit. For an explanation of the policy values, see tibrvQueueLimitPolicy. The program supplies a location, and the function stores the limit policy of the queue in that location.
`maxEvents`	Programs can limit the number of events that a queue can hold—either to curb queue growth, or implement a specialized dispatch semantics. Zero specifies an unlimited number of events. The program supplies a location, and the function stores the maximum event limit of the queue in that location.
`discardAmount`	When the queue exceeds its maximum event limit, discard a block of events. This property specifies the number of events to discard. The program supplies a location, and the function stores the discard amount of the queue in that location.

tibrvQueue_GetLimitPolicy()

Declaration

Purpose

See Also