Represents an event listener container
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
public interface IEventListenerContainer<TData> : IDisposable
Public Interface IEventListenerContainer(Of TData) _ Inherits IDisposable
generic<typename TData> public interface class IEventListenerContainer : IDisposable
Generic Template Parameters
- TData
- Type of data which the container monitors for events.
Members
All Members | Methods | Properties | Events | ||
Icon | Member | Description |
---|---|---|
BatchDataEventArrived |
Occurs when a batch data event arrives.
| |
ContainerExceptionOccured |
Occurs when an exception is thrown during the container's asynchronous life-cycle.
| |
DataEventArrived |
Occurs when a data event arrives.
| |
Dispose()()()() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.) | |
IsActive |
Returns true if the container is currently listening to events, false otherwise.
| |
Name |
Gets or sets the name of the container. This property is not required, but setting a friendly name might be helpful in debugging scenarios.
| |
PerformSnapshot |
Gets or sets whether to perform a Snapshot<(Of <<'(T>)>>)(T) on the Template for improved performance.
| |
SpaceProxy |
Gets or sets the proxy to the space which should be listened to.
| |
Start()()()() |
Starts listening to events.
| |
Stop()()()() |
Stops listening to events. Execution is blocked until the container is fully stopped.
| |
Stop(TimeSpan) |
Stops listening to events. Execution is blocked until the container is fully stopped or the specified timeout elapses.
| |
Stop(Int32) |
Stops listening to events. Execution is blocked until the container is fully stopped or the specified timeout elapses.
| |
Template |
Gets or sets the template that determines which entries this container should listen for.
| |
TransactionManager |
Gets or sets the transaction manager that will be used to create transactions for the event listening and handling operations.
If null, no transactions will be used.
Remarks
This property cannot be changed when the container is running. To change it, Stop()()()() the container, set the new value then Start()()()() it again.
| |
TransactionTimeout |
Gets or sets a transaction timeout value to override the default value in the TransactionManager property.
| |
TransactionType |
Gets or sets the TransactionType. When Manual is used, the transaction type will be determined by the TransactionManager.
| |
UserExceptionOccured |
Occurs when an exception is thrown while DataEventArrived is processed.
| |
Validate()()()() |
Validates the container's configuration.
The container is not configured properly. |