Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

AbstractTransactionalMessageListenerContainer Members

AbstractTransactionalMessageListenerContainer 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 (inherited from AbstractMessageListenerContainer) 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.
ListenerTimeLimit (inherited from AbstractPeekingMessageListenerContainer) Gets or sets the listener time limit to continuously receive messages. The value is specified in milliseconds. The default value is TimeSpan.Zero, indicating to only perform one Receive operation per Peek trigger.
MaxConcurrentListeners (inherited from AbstractPeekingMessageListenerContainer) Gets or sets the max concurrent listeners to receive messages.
MessageListener (inherited from AbstractMessageListenerContainer) Gets or sets the message listener.
MessageQueue (inherited from AbstractPeekingMessageListenerContainer) Gets or sets the message queue used for Peeking.
MessageQueueFactory (inherited from AbstractMessageListenerContainer) Gets or sets the message queue factory.
MessageQueueObjectName (inherited from AbstractMessageListenerContainer) 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.
PlatformTransactionManager Gets or sets the platform transaction manager.
RecoveryTimeSpan (inherited from AbstractMessageListenerContainer) 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.
TransactionDefinition Gets or sets the transaction definition.
TransactionTimeout Sets the transaction timeout to use for transactional wrapping, in seconds. Default is none, using the transaction manager's default timeout.

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

AbstractTransactionalMessageListenerContainer Constructor Initializes a new instance of the AbstractTransactionalMessageListenerContainer class.

Protected Instance Fields

messageQueueMonitor (inherited from AbstractMessageListenerContainer) 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

BeforeMessageReceived (inherited from AbstractPeekingMessageListenerContainer) Template method that gets called right before a new message is received, i.e. messageQueue.Receive().
CloseQueueHandle (inherited from AbstractMessageListenerContainer) 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.
ConfigureInitialPeekThread (inherited from AbstractPeekingMessageListenerContainer) Configures the initial peek thread, setting it to be a background thread. Can be overridden in subclasses.
DoExecuteListener (inherited from AbstractMessageListenerContainer) 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 AbstractPeekingMessageListenerContainer) Retrieves a MessageQueue instance given the MessageQueueObjectName
DoInvokeListener (inherited from AbstractMessageListenerContainer) Invokes the listener. Can be overriden in subclasses.
DoReceiveAndExecute Subclasses perform a receive opertion on the message queue and execute the message listener
DoReceiveAndExecuteUsingPlatformTransactionManager Does the receive and execute using platform transaction manager.
DoShutdown (inherited from AbstractPeekingMessageListenerContainer) Wait for all listener threads to exit and closes the DefaultMessageQueue.
DoStart (inherited from AbstractPeekingMessageListenerContainer) Starts peeking on the DefaultMessageQueue.
DoStop (inherited from AbstractPeekingMessageListenerContainer) Stops peeking on the message queue.
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 (inherited from AbstractMessageListenerContainer) 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.
MessageReceived (inherited from AbstractPeekingMessageListenerContainer) Template method that gets called right when a new message has been received, before attempting to process it. Allows subclasses to react to the event of an actual incoming message, for example adapting their consumer count.
PeekCompleted (inherited from AbstractPeekingMessageListenerContainer) The callback when the peek has completed. Schedule up to the maximum number of concurrent listeners to receive messages off the queue. Delegates to the abstract method DoReceiveAndExecute so that subclasses may customize the receiving process, for example to surround the receive operation with transactional semantics.
ReceiveAndExecute (inherited from AbstractPeekingMessageListenerContainer) Execute the listener for a message received from the given queue wrapping the entire operation in an external transaction if demanded.
RollbackOnException Rollback the transaction on exception.
RunningAllowed (inherited from AbstractListenerContainer) Check whether this container's listeners are generally allowed to run.
StartPeeking (inherited from AbstractPeekingMessageListenerContainer) Starts peeking on the DefaultMessageQueue. This is the method that must be called again at the end of message procesing to continue the peeking process.
ValidateConfiguration (inherited from AbstractMessageListenerContainer) Validates that the messageQueueObjectName is not null. If MessageQueueFactory is null, a DefaultMessageQueueFactory is created. Can be be overridden in subclasses.
WaitForListenerThreadsToExit (inherited from AbstractPeekingMessageListenerContainer) Waits for listener threads to exit.

See Also

AbstractTransactionalMessageListenerContainer Class | Spring.Messaging.Listener Namespace