Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

EmsTemplate Members

EmsTemplate overview

Public Static (Shared) Fields

DEFAULT_RECEIVE_TIMEOUT Timeout value indicating that a receive operation should check if a message is immediately available without blocking.

Public Instance Constructors

EmsTemplate Overloaded. Initializes a new instance of the EmsTemplate class.

Public Instance Properties

ConnectionFactory (inherited from EmsAccessor) Gets or sets the connection factory to use for obtaining EMS Connections.
DefaultDestination Gets or sets the default destination to be used on send/receive operations that do not have a destination parameter.
DefaultDestinationName Gets or sets the name of the default destination name to be used on send/receive operations that do not have a destination parameter.
DeliveryMode Sets a value indicating the delivery mode QOS
DestinationResolver (inherited from EmsDestinationAccessor) Gets or sets the destination resolver that is to be used to resolve Destination references for this accessor.
ExplicitQosEnabled Gets or sets a value indicating whether to use explicit Quality of Service values.
MessageConverter Gets or sets the message converter for this template.
MessageIdEnabled Gets or sets a value indicating whether Message Ids are enabled.
MessageTimestampEnabled Gets or sets a value indicating whether message timestamps are enabled.
Priority Gets or sets the priority when sending.
PubSubDomain (inherited from EmsDestinationAccessor) Gets or sets a value indicating whether Publish/Subscribe domain (Topics) is used. Otherwise, the Point-to-Point domain (Queues) is used.
PubSubNoLocal Gets or sets a value indicating whether to inhibit the delivery of messages published by its own connection.
ReceiveTimeout Gets or sets the receive timeout to use for recieve calls.
SessionAcknowledgeMode (inherited from EmsAccessor) Gets or sets the session acknowledge mode for EMS Sessions including whether or not the session is transacted
SessionTransacted (inherited from EmsAccessor) Set the transaction mode that is used when creating a EMS Session. Default is "false".
TimeToLive Gets or sets the time to live when sending

Public Instance Methods

AfterPropertiesSet (inherited from EmsAccessor) Verify that ConnectionFactory property has been set.
BrowseOverloaded. Browses messages in the default EMS queue. The callback gives access to the EMS Session and QueueBrowser in order to browse the queue and react to the contents.
BrowseSelectedOverloaded. Browses messages in a EMS queue. The callback gives access to the EMS Session and QueueBrowser in order to browse the queue and react to the contents.
BrowseSelectedWithDelegateOverloaded. Browses messages in a EMS queue. The callback gives access to the EMS Session and QueueBrowser in order to browse the queue and react to the contents.
BrowseWithDelegateOverloaded. Browses messages in the default EMS queue. The callback gives access to the EMS Session and QueueBrowser in order to browse the queue and react to the contents.
ConvertAndSendOverloaded. Send the given object to the default destination, converting the object to a EMS message with a configured IMessageConverter. This will only work with a default destination specified!
ConvertAndSendWithDelegateOverloaded. Send the given object to the default destination, converting the object to a EMS message with a configured IMessageConverter. The IMessagePostProcessor callback allows for modification of the message after conversion. This will only work with a default destination specified!
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExecuteOverloaded. Execute the action specified by the given action object within a EMS Session.
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.
ReceiveOverloaded. Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.This will only work with a default destination specified!
ReceiveAndConvertOverloaded. Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured IMessageConverter. This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.This will only work with a default destination specified!
ReceiveSelectedOverloaded. Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.This will only work with a default destination specified!
ReceiveSelectedAndConvertOverloaded. Receive a message synchronously from the default destination, but only wait up to a specified time for delivery. Convert the message into an object with a configured IMessageConverter. This method should be used carefully, since it will block the thread until the message becomes available or until the timeout value is exceeded.This will only work with a default destination specified!
ResolveDestinationName (inherited from EmsDestinationAccessor) Resolves the given destination name to a EMS destination.
SendOverloaded. Send a message to the default destination. This will only work with a default destination specified!
SendWithDelegateOverloaded. Send a message to the default destination. This will only work with a default destination specified!
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

CreateBrowser Creates the queue browser.
CreateConnection (inherited from EmsAccessor) Creates the connection via the ConnectionFactory.
CreateConsumer Create a EMS MessageConsumer for the given Session and Destination.
CreateProducer Create a EMS MessageProducer for the given Session and Destination, configuring it to disable message ids and/or timestamps (if necessary). Delegates to
doCreateProducer
for creation of the raw EMS MessageProducer
CreateSession (inherited from EmsAccessor) Creates the session for the given Connection
DoConvertFromMessage Extract the content from the given JMS message.
DoCreateProducer Create a raw EMS MessageProducer for the given Session and Destination.
DoReceiveOverloaded. Receive a message.
DoSendOverloaded. Send the given message.
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.
GetConnection Fetch an appropriate Connection from the given EmsResourceHolder.
GetSession Fetch an appropriate Session from the given EmsResourceHolder.
InitDefaultStrategies Initialize the default implementations for the template's strategies: DynamicDestinationResolver and SimpleMessageConverter.
IsClientAcknowledge (inherited from EmsAccessor) Returns whether the Session is in client acknowledgement mode.
IsSessionLocallyTransacted Determines whether the given Session is locally transacted, that is, whether its transaction is managed by this template class's Session handling and not by an external transaction coordinator.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

EmsTemplate Class | Spring.Messaging.Ems.Core Namespace