Base class for event listener container that executes the event listening logic.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
public abstract class EventListenerContainer<TData> : IEventListenerContainer<TData>, IDisposable
Public MustInherit Class EventListenerContainer(Of TData) _ Implements IEventListenerContainer(Of TData), IDisposable
generic<typename TData> public ref class EventListenerContainer abstract : IEventListenerContainer<TData>, IDisposable
Generic Template Parameters
- TData
- Type of data which the container monitors for events.
Members
All Members | Constructors | Methods | Properties | Fields | Events |
Icon | Member | Description |
---|---|---|
EventListenerContainer<(Of <(<'TData>)>)>()()()() |
Creates a container without configuration.
| |
EventListenerContainer<(Of <(<'TData>)>)>(ISpaceProxy) |
Creates a container with the specified space proxy.
| |
EventListenerContainer<(Of <(<'TData>)>)>(ISpaceProxy, Object) |
Creates a container with the specified space proxy and template.
| |
_failedEvents |
Number of failed events
| |
_processedEvents |
Number of processed events
| |
ActualTemplate |
Gets the actual template that is used for event listening. If PerformSnapshot is true, this will be the snapshot result of the Template.
| |
AssertNotActive(String) |
Asserts that the container is not running currently, and if it does throws InvalidEventListenerOperationException.
| |
BatchDataEventArrived |
Occurs when a batch data event arrives.
| |
BatchDataEventArrivedHasSubscriptions()()()() |
Returns true if BatchDataEventArrived has subscriptions, false otherwise.
| |
CloneEventListenersPerThread |
Gets or sets whether to clone the event listener containing classes when the container is invoking the DataEventArrived event
from more than one thread
| |
ContainerExceptionOccured |
Occurs when an exception is thrown during the container's asynchronous life-cycle.
| |
DataEventArrived |
Occurs when a data event arrives.
| |
DataEventArrivedHasSubscriptions()()()() |
Returns true if DataEventArrived has subscriptions, false otherwise.
| |
DefaultCloneEventListeners |
Default value for CloneEventListenersPerThread.
| |
DefaultPerformSnapshot |
Default value for PerformSnapshot.
| |
DefaultTransactionCommitAbortTimeout |
Default value for transaction abort or commit when the container is considered transactional.
| |
DefaultTranscationScope |
Default value for TransactionType.
| |
Dispose()()()() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
| |
Equals(Object) |
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.) | |
Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
GetContainerNameLoggingPrefix()()()() |
Creates a container logging prefix.
| |
GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
InitTransaction()()()() |
Creates a transaction using the supplied TransactionManager,
it takes into consideration the TransactionTimeout if it was set to override the default manager timeout.
| |
InvokeBatchDataEventArrived(Object, BatchDataEventArgs<(Of <<'(TData>)>>)) |
Invokes BatchDataEventArrived event.
| |
InvokeContainerExceptionOccured(Object, ContainerExceptionEventArgs) |
Invokes ContainerExceptionOccured event.
| |
InvokeDataEventArrived(Object, DataEventArgs<(Of <<'(TData>)>>)) |
Invokes DataEventArrived event.
| |
InvokeUserExceptionOccured(Object, UserExceptionEventArgs<(Of <<'(TData>)>>)) |
Invokes UserExceptionOccured event.
| |
IsActive |
Returns true if the container is currently listening to events, false otherwise.
| |
IsBatch |
Returns true if the listener is in batch mode, false otherwise.
| |
MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
Mode |
Gets the space mode that container is aware of
| |
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.
| |
OnBecomeNotPrimary()()()() |
Execute container logic that should be done when the underlying space behind the proxy is no longer primary, this method should not block.
| |
OnBecomePrimary()()()() |
Execute container logic that should be done when the underlying space behind the proxy becomes primary, this method should not block.
| |
OnStart()()()() |
Execute container logic that should be done when the container is started, this method should not block.
The container is space mode aware, and should do its work in OnBecomePrimary()()()().
| |
OnStop(Int32) |
Execute container logic that should be done when the container is stopped, this method should not block.
| |
PerformSnapshot |
Gets or sets whether to perform an Snapshot<(Of <<'(T>)>>)(T) on the Template for improved performance.
| |
ProcessContainerException(Exception, ITransaction) |
Processes a container exception.
This method must not throw an exception.
| |
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.
| |
ToString()()()() |
Returns a String that represents the current Object.
(Inherited from Object.) | |
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.
| |
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. |
Inheritance Hierarchy
Object | ||
EventListenerContainer<(Of <(<'TData>)>)> | ||
NotifyEventListenerContainer<(Of <(<'TData>)>)> | ||
PollingEventListenerContainer<(Of <(<'TData>)>)> |