TibrvQueue::getLimitPolicy()

Method

Declaration

TibrvStatus getLimitPolicy (
    tibrvQueueLimitPolicy& policy,
    tibrv_u32& maxEvents,
    tibrv_u32& discardAmount) const;

Extract the limit properties of a queue.

Parameter	Description
`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 Limit Policy. The program supplies a variable, and the method stores the limit policy of the queue in that variable.
`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 variable, and the method stores the maximum event limit of the queue in that variable.
`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 variable, and the method stores the discard amount of the queue in that variable.