MessageQueue.ReceiveByCorrelationId Method (String, TimeSpan, MessageQueueTransaction)

 

Receives the message that matches the given correlation identifier (from a transactional queue) and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

Namespace:   System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

public Message ReceiveByCorrelationId(
	string correlationId,
	TimeSpan timeout,
	MessageQueueTransaction transaction
)

Parameters

correlationId
Type: System.String

The CorrelationId of the message to receive.

timeout
Type: System.TimeSpan

A TimeSpan that indicates the time to wait until a new message is available for inspection.

transaction
Type: System.Messaging.MessageQueueTransaction

The MessageQueueTransaction object.

Return Value

Type: System.Messaging.Message

The Message whose CorrelationId matches the correlationId parameter passed in.

Exception Condition
ArgumentNullException

The correlationId parameter is null.

-or-

The transaction parameter is null.

ArgumentException

The value specified for the timeout parameter is not valid, possibly timeout is less than TimeSpan.Zero or greater than MessageQueue.InfiniteTimeout.

MessageQueueException

The message with the specified correlationId does not exist in the queue and did not arrive before the time-out expired.

-or-

The queue is non-transactional.

-or-

An error occurred when accessing a Message Queuing method.

This method looks in the transactional queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. This method returns immediately if the message with the correlation identifier specified by the correlationId parameter is in the queue, using the internal transaction context defined by the transaction parameter. Otherwise, the method waits the given period of time for a new message to arrive. If a new message does not arrive before the time-out expires, an exception is thrown.

The timeout parameter does not specify the total running time for this method. Rather, it specifies the time to wait for a new message to arrive in the queue. Each time a new message arrives, this method examines the CorrelationId of the new message to see if it matches the correlationId parameter. If not, this method starts the time-out period over and waits for another new message to arrive. Therefore, if new messages continue to arrive within the time-out period, it is possible for this method to continue running indefinitely, either until the time-out period expires without any new messages arriving, or until a message arrives whose CorrelationId matches the correlationId parameter.

Because this method is called on a transactional queue, the message that is received would be returned to the queue if the transaction is aborted. The message is not permanently removed from the queue until the transaction is committed.

The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

Two other methods allow you to receive messages from a queue. The Receive method returns the first message in the queue, and the ReceiveById(String) method is used to retrieve a message by specifying its unique identifier.

To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue. There is no transaction context associated with a message returned by a call to PeekByCorrelationId(String). Because PeekByCorrelationId(String) does not remove any messages in the queue, there would be nothing to roll back if the transaction were aborted.

The following table shows whether this method is available in various Workgroup modes.

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

No

Remote computer and direct format name

Yes

The following code example demonstrates the use of ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction).


// Connect to a nontransactional queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

// Connect to a transactional queue on the local computer.
MessageQueue transQueue = new MessageQueue(".\\exampleTransQueue");

// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;

// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType.Single);

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;

// Create a message queuing transaction.
MessageQueueTransaction transaction = new MessageQueueTransaction();

try
{
    // Begin a transaction.
    transaction.Begin();

    // Receive the response message from the transactional queue.
    responseMsg = transQueue.ReceiveByCorrelationId(id,
        TimeSpan.FromSeconds(10.0), transaction);

    // Commit the transaction.
    transaction.Commit();
}
catch(System.Exception e)
{
    // Cancel the transaction.
    transaction.Abort();

    // Propagate the exception.
    throw e;
}
finally
{
    // Dispose of the transaction object.
    transaction.Dispose();
}

// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
    responseMsg.CorrelationId);

.NET Framework
Available since 1.1
Return to top
Show: