RFA .NET

The EventQueue type exposes the following members.

Methods

  NameDescription
Public methodStatic memberCreate(RFA_String)
Creates an event queue with 'name'.
Public methodStatic memberCreate(RFA_String, Boolean)
Creates an event queue with 'name'.
Public methodDeactivate
Deactivates the dispatchable.
(Overrides Dispatchable..::..Deactivate()()()().)
Public methodDestroy
Destroys the Dispatchable.
(Overrides Dispatchable..::..Destroy()()()().)
Public methodDispatch()()()()
Dispatches the next event. No wait if no event is immediately available, or otherwise dispatch one available event.
(Overrides Dispatchable..::..Dispatch()()()().)
Public methodDispatch(Int32)
Dispatches the next event. Wait for the "timeOut" milliseconds if no event is immediately available, or otherwise dispatch one available event.
(Overrides Dispatchable..::..Dispatch(Int32).)
Public methodRegisterHighThresholdNotificationClient
Registers a high threshold notification client.
(Overrides Dispatchable..::..RegisterHighThresholdNotificationClient(DispatchableNotificationClient, Object).)
Public methodRegisterLowThresholdNotificationClient
Registers a low threshold notification client.
(Overrides Dispatchable..::..RegisterLowThresholdNotificationClient(DispatchableNotificationClient, Object).)
Public methodRegisterMaxDepthNotificationClient
Registers a maximum depth reached notification client.
(Overrides Dispatchable..::..RegisterMaxDepthNotificationClient(DispatchableNotificationClient, Object).)
Public methodRegisterNotificationClient
Registers a notification client.
(Overrides Dispatchable..::..RegisterNotificationClient(DispatchableNotificationClient, Object).)
Public methodResetEventQueue
Clears any remaining events from queue and restarts queuing events.
Public methodSetEventQueueThreshold
Sets the low and high threshold values of the event queue.
Public methodToRFA_String
String representation of this object.
(Overrides Dispatchable..::..ToRFA_String()()()().)
Public methodToString
String representation of this object.
(Overrides Dispatchable..::..ToString()()()().)
Public methodUnregisterHighThresholdNotificationClient
Unregisters a client from event queue high threshold notification.
(Overrides Dispatchable..::..UnregisterHighThresholdNotificationClient(DispatchableNotificationClient).)
Public methodUnregisterLowThresholdNotificationClient
Unregisters a client from event queue low threshold notification.
(Overrides Dispatchable..::..UnregisterLowThresholdNotificationClient(DispatchableNotificationClient).)
Public methodUnregisterMaxDepthNotificationClient
Unregisters a client from event queue max depth reached notification.
(Overrides Dispatchable..::..UnregisterMaxDepthNotificationClient(DispatchableNotificationClient).)
Public methodUnregisterNotificationClient
Unregisters a client with the queue.
(Overrides Dispatchable..::..UnregisterNotificationClient(DispatchableNotificationClient).)

Properties

  NameDescription
Public propertyEventQueueCurrentSize
Gets the current number of events stored in the event queue.
Public propertyEventQueueHighThreshold
Gets the high threshold value of the event queue.
Public propertyEventQueueLowThreshold
Gets the low threshold value of the event queue.
Public propertyEventQueueMaxDepth
Gets or sets the maximum depth of the event queue.
Public propertyHasActiveEventStreams
Gets the boolean value to determine the dispatchable have any active event streams.
(Overrides Dispatchable..::..HasActiveEventStreams.)
Public propertyIsActive
Gets the boolean value to determine if the dispatchable is currently active.
(Inherited from Dispatchable.)
Public propertyName
Gets the name of the event queue.
(Inherited from Dispatchable.)

See Also