Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

AbstractMessageListenerContainer Members

AbstractMessageListenerContainer overview

Public Instance Properties

Active (inherited from AbstractListenerContainer) Gets a value indicating whether this Container is active, that is, whether it has been set up but not shut down yet.
ApplicationContext Gets or sets the IApplicationContext that this object runs in.
AutoStartup (inherited from AbstractListenerContainer) Sets a value indicating whether to automatically start the container after initialization. Default is "true"; set this to "false" to allow for manual startup though the Start method.
MessageListener Gets or sets the message listener.
MessageQueueFactory Gets or sets the message queue factory.
MessageQueueObjectName Gets or sets the name of the message queue object, as refered to in the Spring configuration, that will be used to create a DefaultMessageQueue instance for consuming messages in the container.
ObjectName (inherited from AbstractListenerContainer) Return the object name that this listener container has been assigned in its containing object factory, if any.
RecoveryTimeSpan Gets or sets the recovery time span, how long to sleep after an exception in processing occured to avoid excessive redelivery attempts. Default value is 1 second.
Running (inherited from AbstractListenerContainer) Gets a value indicating whether this Container is running, that is whether it has been started and not stopped yet.

Public Instance Methods

AfterPropertiesSet (inherited from AbstractListenerContainer) Delegates to ValidateConfiguration and Initialize
Dispose (inherited from AbstractListenerContainer) Calls Shutdown when the application context destroys the container instance.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
Initialize (inherited from AbstractListenerContainer) Initializes this container. Calls the abstract method DoInitialize to initialize the listening infrastructure (i.e. subclasses will typically resolve a MessageQueue instance from a MessageQueueObjectName) and then calls the abstract method DoStart if the property AutoStartup is set to true,
Shutdown (inherited from AbstractListenerContainer) Sets the container state to inactive and not running, calls template method DoShutdown
Start (inherited from AbstractListenerContainer) Starts this container.
Stop (inherited from AbstractListenerContainer) Stops this instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Constructors

AbstractMessageListenerContainer Constructor Initializes a new instance of the AbstractMessageListenerContainer class.

Protected Instance Fields

messageQueueMonitor Most operations within the MessageListener container hierarchy use methods on the MessageQueue instance which are thread safe (BeginPeek, BeginReceive, EndPeek, EndReceive, GetAllMessages, Peek, and Receive). When using another method on the shared MessageQueue instance, wrap calls with a lock on this object.

Protected Instance Methods

CloseQueueHandle Closes the queue handle. Cancel pending receive operation by closing the queue handle To properly dispose of the queue handle, ensure that EnableConnectionCache=false on the MessageQueue that this listener is configured to use.
DoExecuteListener Template method that execute listener with the provided message if Running is true. Subclasses will call this method at the appropriate point in their processing lifecycle, for example committing or rolling back a transaction if needed.
DoInitialize (inherited from AbstractListenerContainer) Subclasses need to implement this method for their specific listener management process.
DoInvokeListener Invokes the listener. Can be overriden in subclasses.
DoShutdown (inherited from AbstractListenerContainer) Subclasses need to implement this method for their specific listener management process.
DoStart (inherited from AbstractListenerContainer) Sets the state to running, can be overridden in subclasses.
DoStop (inherited from AbstractListenerContainer) Template method suitable for overriding that stops the container.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
InvokeListener Invokes the listener if it is not null. Invokes the method DoInvokeListener. Can be overridden in subclasses.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
RunningAllowed (inherited from AbstractListenerContainer) Check whether this container's listeners are generally allowed to run.
ValidateConfiguration Validates that the messageQueueObjectName is not null. If MessageQueueFactory is null, a DefaultMessageQueueFactory is created. Can be be overridden in subclasses.

See Also

AbstractMessageListenerContainer Class | Spring.Messaging.Listener Namespace