EventQueueMode Property

Eth32QueueMode EventQueueMode

Summary

This property configures the behavior of the event queue within the API. If the event queue ever becomes full (reaches the limit configured by the EventQueueLimit Property) and new events arrive, either old events will be shifted out to make room for the new, or the new events will be ignored, depending on the behavior you have specified with this property. The Eth32QueueMode.DiscardNew setting is the default when a new connection is created.

Parameters

This property does not have any parameters.

Value

This property is a Eth32QueueMode enumerator type, which has the following valid values:

  • Eth32QueueMode.DiscardNew - When the queue is full, discard any new events.

  • Eth32QueueMode.DiscardOld - When the queue is full, shift out the oldest event to make room for the new event at the end of the queue.

Remarks

The event queue size that is considered full is defined by the EventQueueLimit Property.

See Also

EventQueueLimit Property