MessageQueue.ReceiveByCorrelationId Метод

Определение

Пространство имен:: System.Messaging

Сборка:: System.Messaging.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Получает сообщение, соответствующее заданному идентификатору корреляции.

Перегрузки

Имя	Описание
ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)	Получает сообщение, соответствующее заданному идентификатору корреляции, и ожидает, пока сообщение с указанным идентификатором корреляции будет доступно в очереди или истекает время ожидания.
ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)	Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди транзакций), и ожидает, пока сообщение с указанным идентификатором корреляции будет доступно в очереди или истекает время ожидания.
ReceiveByCorrelationId(String, TimeSpan)	Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди, отличной от транзакций), и ожидает, пока сообщение с указанным идентификатором корреляции будет доступно в очереди или истекает время ожидания.
ReceiveByCorrelationId(String, MessageQueueTransactionType)	Получает сообщение, соответствующее заданному идентификатору корреляции, и немедленно вызывает исключение, если в очереди нет сообщения с указанным идентификатором корреляции.
ReceiveByCorrelationId(String, MessageQueueTransaction)	Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди транзакций), и немедленно вызывает исключение, если сообщение с указанным идентификатором корреляции в настоящее время отсутствует в очереди.
ReceiveByCorrelationId(String)	Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди, отличной от транзакций), и немедленно вызывает исключение, если сообщение с указанным идентификатором корреляции в настоящее время отсутствует в очереди.

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)

Получает сообщение, соответствующее заданному идентификатору корреляции, и ожидает, пока сообщение с указанным идентификатором корреляции будет доступно в очереди или истекает время ожидания.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout, System::Messaging::MessageQueueTransactionType transactionType);

public System.Messaging.Message ReceiveByCorrelationId(string correlationId, TimeSpan timeout, System.Messaging.MessageQueueTransactionType transactionType);

member this.ReceiveByCorrelationId : string * TimeSpan * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message

Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan, transactionType As MessageQueueTransactionType) As Message

Параметры

correlationId: String

Сообщение CorrelationId для получения.

timeout: TimeSpan

Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.

transactionType: MessageQueueTransactionType

Одно из MessageQueueTransactionType значений, описывающее тип контекста транзакции для связывания с сообщением.

Возвращаемое значение

Message

Message Чей CorrelationId параметр соответствует переданным параметруcorrelationId.

Исключения

ArgumentNullException

Параметр correlationId имеет значение null.

InvalidOperationException

Сообщение с указанным correlationId не удалось найти.

ArgumentException

Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.

InvalidEnumArgumentException

Параметр transactionType не является одним из MessageQueueTransactionType членов.

MessageQueueException

Сообщение с указанным correlationId не существует в очереди и не прибыло до истечения срока ожидания.

–или–

Произошла ошибка при доступе к методу очереди сообщений.

Примеры

В следующем примере кода показано использование ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType).


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

// Create a new message.
Message^ msg = gcnew 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 =
    gcnew MessageQueue(".\\exampleTransQueue");

// Create a new message in response to the original message.
Message^ responseMsg = gcnew 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;

// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
    TimeSpan::FromSeconds(10.0), MessageQueueTransactionType::Single);

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

transQueue->Close();
queue->Close();


// 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;

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

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

Этот метод выглядит в очереди, на которую ссылается MessageQueue сообщение, соответствующее CorrelationId указанному correlationId параметру. Этот метод возвращается немедленно, если сообщение с идентификатором корреляции, указанным параметром, находится в очереди, используя контекст транзакции, определенный correlationId параметром transactionType . В противном случае метод ожидает заданного периода времени, пока появится новое сообщение. Если новое сообщение не поступает до истечения срока ожидания, создается исключение.

Параметр timeout не указывает общее время выполнения этого метода. Скорее, он указывает время ожидания нового сообщения в очередь. Каждый раз при поступлении нового сообщения этот метод проверяет CorrelationId новое сообщение, чтобы узнать, соответствует ли он параметру correlationId . Если нет, этот метод запускает период ожидания и ожидает поступления другого нового сообщения. Таким образом, если новые сообщения продолжают поступать в течение периода ожидания, этот метод может продолжать работать бесконечно, либо до истечения срока ожидания без новых сообщений, либо до тех пор, пока сообщение не поступает, соответствующее CorrelationId параметру correlationId . Укажите Automatic для transactionType параметра, если уже есть внешний контекст транзакции, подключенный к потоку, который вы хотите использовать для получения сообщения. Укажите Single , хотите ли вы получить сообщение как одну внутреннюю транзакцию. Можно указать None , нужно ли получать сообщение из очереди транзакций за пределами контекста транзакции.

Если этот метод вызывается для получения сообщения из очереди транзакций, полученное сообщение будет возвращено в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.

Свойство CorrelationId используется для привязки сообщения, отправленного в очередь, для связанных ответов, отчетов или подтверждения сообщений.

Два других метода позволяют получать сообщения из очереди. Метод Receive возвращает первое сообщение в очереди, а ReceiveById(String) метод используется для получения сообщения, указав его уникальный идентификатор.

Чтобы прочитать сообщение с указанным идентификатором корреляции, не удаляя его из очереди, используйте PeekByCorrelationId(String) метод. Метод PeekByCorrelationId(String) всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом. Контекст транзакции не связан с сообщением, возвращаемым вызовом PeekByCorrelationId(String). Так как PeekByCorrelationId(String) не удаляет сообщения в очереди, откат транзакции не будет ничего делать, если транзакция была прервана.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	В наличии
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Нет
Имя удаленного компьютера и прямого формата	Да

См. также раздел

Применяется к

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)

Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди транзакций), и ожидает, пока сообщение с указанным идентификатором корреляции будет доступно в очереди или истекает время ожидания.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout, System::Messaging::MessageQueueTransaction ^ transaction);

public System.Messaging.Message ReceiveByCorrelationId(string correlationId, TimeSpan timeout, System.Messaging.MessageQueueTransaction transaction);

member this.ReceiveByCorrelationId : string * TimeSpan * System.Messaging.MessageQueueTransaction -> System.Messaging.Message

Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan, transaction As MessageQueueTransaction) As Message

Параметры

correlationId: String

Сообщение CorrelationId для получения.

timeout: TimeSpan

Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.

transaction: MessageQueueTransaction

Объект MessageQueueTransaction.

Возвращаемое значение

Message

Message Чей CorrelationId параметр соответствует переданным параметруcorrelationId.

Исключения

ArgumentNullException

Параметр correlationId имеет значение null.

–или–

Параметр transaction имеет значение null.

ArgumentException

Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.

MessageQueueException

Сообщение с указанным correlationId не существует в очереди и не прибыло до истечения срока ожидания.

–или–

Очередь не является транзакционной.

–или–

Произошла ошибка при доступе к методу очереди сообщений.

Примеры

В следующем примере кода показано использование ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction).


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

// Create a new message.
Message^ msg = gcnew 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 =
    gcnew MessageQueue(".\\exampleTransQueue");

// Create a new message in response to the original message.
Message^ responseMsg = gcnew 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 = gcnew 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 (Exception^ ex)
{
    // Cancel the transaction.
    transaction->Abort();

    // Propagate the exception.
    throw ex;
}
finally
{
    // Dispose of the transaction object.
    delete transaction;
    transQueue->Close();
    queue->Close();
}

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


// 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);

Этот метод выглядит в очереди транзакций, MessageQueue на которую ссылается сообщение, соответствующее CorrelationId указанному correlationId параметру. Этот метод возвращает немедленно, если сообщение с идентификатором корреляции, указанным параметром, находится в очереди, используя внутренний контекст транзакции, определенный correlationId параметром transaction . В противном случае метод ожидает заданного периода времени, пока появится новое сообщение. Если новое сообщение не поступает до истечения срока ожидания, создается исключение.

Так как этот метод вызывается в очереди транзакций, полученное сообщение будет возвращено в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	В наличии
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Нет
Имя удаленного компьютера и прямого формата	Да

См. также раздел

Применяется к

ReceiveByCorrelationId(String, TimeSpan)

Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди, отличной от транзакций), и ожидает, пока сообщение с указанным идентификатором корреляции будет доступно в очереди или истекает время ожидания.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout);

public System.Messaging.Message ReceiveByCorrelationId(string correlationId, TimeSpan timeout);

member this.ReceiveByCorrelationId : string * TimeSpan -> System.Messaging.Message

Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan) As Message

Параметры

correlationId: String

Сообщение CorrelationId для получения.

timeout: TimeSpan

Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.

Возвращаемое значение

Message

Message Чей CorrelationId параметр соответствует переданным параметруcorrelationId.

Исключения

ArgumentNullException

Параметр correlationId имеет значение null.

ArgumentException

Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.

MessageQueueException

Сообщение с указанным correlationId не существует в очереди и не прибыло до истечения срока ожидания.

–или–

Произошла ошибка при доступе к методу очереди сообщений.

Примеры

В следующем примере кода показано использование ReceiveByCorrelationId(String, TimeSpan).


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

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

// Designate a queue to receive the acknowledgement message for this
// message.
msg->AdministrationQueue =
    gcnew MessageQueue(".\\exampleAdminQueue");

// Set the message to generate an acknowledgement message upon its
// arrival.
msg->AcknowledgeType = AcknowledgeTypes::PositiveArrival;

// Send the message.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

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

// Connect to the admin queue.
MessageQueue^ adminQueue =
    gcnew MessageQueue(".\\exampleAdminQueue");

// Set the admin queue's MessageReadPropertyFilter property to ensure
// that the acknowledgement message includes the desired properties.
adminQueue->MessageReadPropertyFilter->Acknowledgment = true;
adminQueue->MessageReadPropertyFilter->CorrelationId = true;

// Receive the acknowledgement message from the admin queue.
Message^ ackMsg = adminQueue->ReceiveByCorrelationId(id,
    TimeSpan::FromSeconds(10.0));

// Display the acknowledgement message's property values.
Console::WriteLine("Message.Label: {0}", ackMsg->Label);
Console::WriteLine("Message.Acknowledgment: {0}",
    ackMsg->Acknowledgment);
Console::WriteLine("Message.CorrelationId: {0}", ackMsg->CorrelationId);

adminQueue->Close();
queue->Close();


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

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

// Designate a queue to receive the acknowledgement message for this
// message.
msg.AdministrationQueue = new MessageQueue(".\\exampleAdminQueue");

// Set the message to generate an acknowledgement message upon its
// arrival.
msg.AcknowledgeType = AcknowledgeTypes.PositiveArrival;

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

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

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

// Connect to the admin queue.
MessageQueue adminQueue = new MessageQueue(".\\exampleAdminQueue");

// Set the admin queue's MessageReadPropertyFilter property to ensure
// that the acknowledgement message includes the desired properties.
adminQueue.MessageReadPropertyFilter.Acknowledgment = true;
adminQueue.MessageReadPropertyFilter.CorrelationId = true;

// Receive the acknowledgement message from the admin queue.
Message ackMsg = adminQueue.ReceiveByCorrelationId(id,
    TimeSpan.FromSeconds(10.0));

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

Этот метод выглядит в очереди, отличной от транзакций, на которую ссылается MessageQueue сообщение, соответствующее CorrelationId указанному correlationId параметру. Этот метод возвращается немедленно, если сообщение с идентификатором корреляции, указанным correlationId параметром, находится в очереди. В противном случае метод ожидает заданного периода времени, пока появится новое сообщение. Если новое сообщение не поступает до истечения срока ожидания, создается исключение.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	В наличии
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Нет
Имя удаленного компьютера и прямого формата	Да

См. также раздел

Применяется к

ReceiveByCorrelationId(String, MessageQueueTransactionType)

Получает сообщение, соответствующее заданному идентификатору корреляции, и немедленно вызывает исключение, если в очереди нет сообщения с указанным идентификатором корреляции.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, System::Messaging::MessageQueueTransactionType transactionType);

public System.Messaging.Message ReceiveByCorrelationId(string correlationId, System.Messaging.MessageQueueTransactionType transactionType);

member this.ReceiveByCorrelationId : string * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message

Public Function ReceiveByCorrelationId (correlationId As String, transactionType As MessageQueueTransactionType) As Message

Параметры

correlationId: String

Сообщение CorrelationId для получения.

transactionType: MessageQueueTransactionType

Одно из MessageQueueTransactionType значений, описывающее тип контекста транзакции для связывания с сообщением.

Возвращаемое значение

Message

Message Чей CorrelationId параметр соответствует переданным параметруcorrelationId.

Исключения

ArgumentNullException

Параметр correlationId имеет значение null.

InvalidOperationException

Сообщение с указанным correlationId не удалось найти.

InvalidEnumArgumentException

Параметр transactionType не является одним из MessageQueueTransactionType членов.

MessageQueueException

Произошла ошибка при доступе к методу очереди сообщений.

Примеры

В следующем примере кода показано использование ReceiveByCorrelationId(String, MessageQueueTransactionType).


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

// Create a new message.
Message^ msg = gcnew 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 =
    gcnew MessageQueue(".\\exampleTransQueue");

// Create a new message in response to the original message.
Message^ responseMsg = gcnew 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);

// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));

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

// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
    MessageQueueTransactionType::Single);

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

transQueue->Close();
queue->Close();


// 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);

// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));

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

// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id,
    MessageQueueTransactionType.Single);

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

Этот метод выглядит в очереди, на которую ссылается MessageQueue сообщение, соответствующее CorrelationId указанному correlationId параметру. Если сообщение не найдено, соответствующее параметру correlationID , создается исключение. В противном случае сообщение удаляется из очереди и возвращается в приложение с помощью контекста транзакции, определенного transactionType параметром.

Укажите Automatic для transactionType параметра, если уже есть внешний контекст транзакции, подключенный к потоку, который вы хотите использовать для получения сообщения. Укажите Single , хотите ли вы получить сообщение как одну внутреннюю транзакцию. Можно указать None , нужно ли получать сообщение из очереди транзакций за пределами контекста транзакции.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	В наличии
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Нет
Имя удаленного компьютера и прямого формата	Да

См. также раздел

Применяется к

ReceiveByCorrelationId(String, MessageQueueTransaction)

Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди транзакций), и немедленно вызывает исключение, если сообщение с указанным идентификатором корреляции в настоящее время отсутствует в очереди.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, System::Messaging::MessageQueueTransaction ^ transaction);

public System.Messaging.Message ReceiveByCorrelationId(string correlationId, System.Messaging.MessageQueueTransaction transaction);

member this.ReceiveByCorrelationId : string * System.Messaging.MessageQueueTransaction -> System.Messaging.Message

Public Function ReceiveByCorrelationId (correlationId As String, transaction As MessageQueueTransaction) As Message

Параметры

correlationId: String

Сообщение CorrelationId для получения.

transaction: MessageQueueTransaction

Объект MessageQueueTransaction.

Возвращаемое значение

Message

Message Чей CorrelationId параметр соответствует переданным параметруcorrelationId.

Исключения

ArgumentNullException

Параметр correlationId имеет значение null.

–или–

Параметр transaction имеет значение null.

InvalidOperationException

Сообщение с указанным correlationId не удалось найти.

MessageQueueException

Очередь не является транзакционной.

–или–

Произошла ошибка при доступе к методу очереди сообщений.

Примеры

В следующем примере кода показано использование ReceiveByCorrelationId(String, MessageQueueTransaction).


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

// Create a new message.
Message^ msg = gcnew 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 =
    gcnew MessageQueue(".\\exampleTransQueue");

// Create a new message in response to the original message.
Message^ responseMsg = gcnew 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);

// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));

// 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 = gcnew MessageQueueTransaction();

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

    // Receive the response message from the transactional queue.
    responseMsg = transQueue->ReceiveByCorrelationId(id, transaction);

    // Commit the transaction.
    transaction->Commit();
}
catch (Exception^ ex)
{
    // Cancel the transaction.
    transaction->Abort();

    // Propagate the exception.
    throw ex;
}
finally
{
    // Dispose of the transaction object.
    delete transaction;
    transQueue->Close();
    queue->Close();
}

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


// 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);

// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));

// 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, 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);

Этот метод выглядит в очереди транзакций, MessageQueue на которую ссылается сообщение, соответствующее CorrelationId указанному correlationId параметру. Если сообщение не найдено, соответствующее параметру correlationID , создается исключение. В противном случае сообщение удаляется из очереди и возвращается в приложение с помощью контекста внутренней транзакции, определенного transaction параметром.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	В наличии
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Нет
Имя удаленного компьютера и прямого формата	Да

См. также раздел

Применяется к

ReceiveByCorrelationId(String)

Получает сообщение, соответствующее заданному идентификатору корреляции (из очереди, отличной от транзакций), и немедленно вызывает исключение, если сообщение с указанным идентификатором корреляции в настоящее время отсутствует в очереди.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId);

public System.Messaging.Message ReceiveByCorrelationId(string correlationId);

member this.ReceiveByCorrelationId : string -> System.Messaging.Message

Public Function ReceiveByCorrelationId (correlationId As String) As Message

Параметры

correlationId: String

Сообщение CorrelationId для получения.

Возвращаемое значение

Message

Message Чей CorrelationId параметр соответствует переданным параметруcorrelationId.

Исключения

ArgumentNullException

Параметр correlationId имеет значение null.

InvalidOperationException

Сообщение с указанным correlationId не удалось найти.

MessageQueueException

Произошла ошибка при доступе к методу очереди сообщений.

Примеры

В следующем примере кода отправляется и получается сообщение, содержащее заказ на очередь и из нее. Он специально запрашивает положительное подтверждение, когда исходное сообщение достигает или извлекается из очереди.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:
   static void CreateQueue( String^ queuePath )
   {
      try
      {
         if (  !MessageQueue::Exists( queuePath ) )
         {
            MessageQueue::Create( queuePath );
         }
         else
         {
            Console::WriteLine(  "{0} already exists.", queuePath );
         }
      }
      catch ( MessageQueueException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

   }

   void SendMessage()
   {
      // Connect to a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

      // Create a new message.
      Message^ myMessage = gcnew Message( "Original Message" );
      myMessage->AdministrationQueue = gcnew MessageQueue( ".\\myAdministrationQueue" );
      myMessage->AcknowledgeType = (AcknowledgeTypes)(AcknowledgeTypes::PositiveReceive | AcknowledgeTypes::PositiveArrival);

      // Send the Order to the queue.
      myQueue->Send( myMessage );
      return;
   }

   String^ ReceiveMessage()
   {
      // Connect to the a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
      myQueue->MessageReadPropertyFilter->CorrelationId = true;
      array<Type^>^p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );
      String^ returnString = nullptr;
      try
      {
         // Receive and format the message. 
         Message^ myMessage = myQueue->Receive();

         // Display message information.
         Console::WriteLine( "____________________________________________" );
         Console::WriteLine( "Original message information--" );
         Console::WriteLine( "Body: {0}", myMessage->Body );
         Console::WriteLine( "Id: {0}", myMessage->Id );
         Console::WriteLine( "____________________________________________" );
         returnString = myMessage->Id;
      }
      catch ( MessageQueueException^ ) 
      {
         // Handle Message Queuing exceptions.
      }
      // Handle invalid serialization format.
      catch ( InvalidOperationException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

      // Catch other exceptions as necessary.
      return returnString;
   }

   void ReceiveAcknowledgment( String^ messageId, String^ queuePath )
   {
      bool found = false;
      MessageQueue^ queue = gcnew MessageQueue( queuePath );
      queue->MessageReadPropertyFilter->CorrelationId = true;
      queue->MessageReadPropertyFilter->Acknowledgment = true;
      try
      {
         while ( queue->PeekByCorrelationId( messageId ) != nullptr )
         {
            Message^ myAcknowledgmentMessage = queue->ReceiveByCorrelationId( messageId );

            // Output acknowledgment message information. The correlation Id is identical
            // to the id of the original message.
            Console::WriteLine( "Acknowledgment Message Information--" );
            Console::WriteLine( "Correlation Id: {0}", myAcknowledgmentMessage->CorrelationId );
            Console::WriteLine( "Id: {0}", myAcknowledgmentMessage->Id );
            Console::WriteLine( "Acknowledgment Type: {0}", myAcknowledgmentMessage->Acknowledgment );
            Console::WriteLine( "____________________________________________" );
            found = true;
         }
      }
      catch ( InvalidOperationException^ e ) 
      {
         // This exception would be thrown if there is no (further) acknowledgment message
         // with the specified correlation Id. Only output a message if there are no messages;
         // not if the loop has found at least one.
         if ( !found )
         {
            Console::WriteLine( e->Message );
         }

         // Handle other causes of invalid operation exception.
      }

   }

};

int main()
{
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;

   // Create new queues.
   MyNewQueue::CreateQueue( ".\\myQueue" );
   MyNewQueue::CreateQueue( ".\\myAdministrationQueue" );

   // Send messages to a queue.
   myNewQueue->SendMessage();

   // Receive messages from a queue.
   String^ messageId = myNewQueue->ReceiveMessage();

   // Receive acknowledgment message.
   if ( messageId != nullptr )
   {
      myNewQueue->ReceiveAcknowledgment( messageId, ".\\myAdministrationQueue" );
   }

   return 0;
}

using System;
using System.Messaging;

namespace MyProject
{

    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue
    {

        //**************************************************
        // Provides an entry point into the application.
        //		
        // This example sends and receives a message from
        // a queue.
        //**************************************************

        public static void Main()
        {
            // Create a new instance of the class.
            MyNewQueue myNewQueue = new MyNewQueue();

            // Create new queues.
            CreateQueue(".\\myQueue");
            CreateQueue(".\\myAdministrationQueue");

            // Send messages to a queue.
            myNewQueue.SendMessage();

            // Receive messages from a queue.
            string messageId = myNewQueue.ReceiveMessage();

            // Receive acknowledgment message.
            if(messageId != null)
            {
                myNewQueue.ReceiveAcknowledgment(messageId, ".\\myAdministrationQueue");
            }

            return;
        }

        //**************************************************
        // Creates a new queue.
        //**************************************************

        public static void CreateQueue(string queuePath)
        {
            try	
            {
                if(!MessageQueue.Exists(queuePath))
                {
                    MessageQueue.Create(queuePath);
                }
                else
                {
                    Console.WriteLine(queuePath + " already exists.");
                }
            }
            catch (MessageQueueException e)
            {
                Console.WriteLine(e.Message);
            }
        }

        //**************************************************
        // Sends a string message to a queue.
        //**************************************************
        
        public void SendMessage()
        {

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

            // Create a new message.
            Message myMessage = new Message("Original Message");

            myMessage.AdministrationQueue = new MessageQueue(".\\myAdministrationQueue");
            myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive | AcknowledgeTypes.PositiveArrival;

            // Send the Order to the queue.
            myQueue.Send(myMessage);

            return;
        }

        //**************************************************
        // Receives a message containing an Order.
        //**************************************************
        
        public  string ReceiveMessage()
        {
            // Connect to the a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            myQueue.MessageReadPropertyFilter.CorrelationId = true;

            // Set the formatter to indicate body contains an Order.
            myQueue.Formatter = new XmlMessageFormatter(new Type[]
                {typeof(string)});

            string returnString = null;
            
            try
            {
                // Receive and format the message.
                Message myMessage =	myQueue.Receive();

                // Display message information.
                Console.WriteLine("____________________________________________");
                Console.WriteLine("Original message information--");
                Console.WriteLine("Body: " +myMessage.Body.ToString());
                Console.WriteLine("Id: " + myMessage.Id.ToString());
                Console.WriteLine("____________________________________________");

                returnString =  myMessage.Id;
            }
            
            catch (MessageQueueException)
            {
                // Handle Message Queuing exceptions.
            }

            // Handle invalid serialization format.
            catch (InvalidOperationException e)
            {
                Console.WriteLine(e.Message);
            }
            
            // Catch other exceptions as necessary.

            return returnString;
        }

        //**************************************************
        // Receives a message containing an Order.
        //**************************************************
        
        public void ReceiveAcknowledgment(string messageId, string queuePath)
        {
            bool found = false;
            MessageQueue queue = new MessageQueue(queuePath);
            queue.MessageReadPropertyFilter.CorrelationId = true;
            queue.MessageReadPropertyFilter.Acknowledgment = true;

            try
            {
                while(queue.PeekByCorrelationId(messageId) != null)
                {
                    Message myAcknowledgmentMessage = queue.ReceiveByCorrelationId(messageId);
            
                    // Output acknowledgment message information. The correlation Id is identical
                    // to the id of the original message.
                    Console.WriteLine("Acknowledgment Message Information--");
                    Console.WriteLine("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString());
                    Console.WriteLine("Id: " + myAcknowledgmentMessage.Id.ToString());
                    Console.WriteLine("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString());
                    Console.WriteLine("____________________________________________");

                    found = true;
                }
            }
            catch (InvalidOperationException e)
            {
                // This exception would be thrown if there is no (further) acknowledgment message
                // with the specified correlation Id. Only output a message if there are no messages;
                // not if the loop has found at least one.
                if (!found)
                {	
                    Console.WriteLine(e.Message);
                }

                // Handle other causes of invalid operation exception.
            }
        }
    }
}

Imports System.Messaging


' Provides a container class for the example.

Public Class MyNewQueue
   
   

   ' Provides an entry point into the application.       
   ' This example sends and receives a message from
   ' a queue.
      
   Public Shared Sub Main()
         ' Create a new instance of the class.
         Dim myNewQueue As New MyNewQueue()
         
         ' Create new queues.
         CreateQueue(".\myQueue")
         CreateQueue(".\myAdministrationQueue")
         
         ' Send messages to a queue.
         myNewQueue.SendMessage()
         
         ' Receive messages from a queue.
         Dim messageId As String = myNewQueue.ReceiveMessage()
         
         ' Receive acknowledgment message.
         If Not (messageId Is Nothing) Then
            myNewQueue.ReceiveAcknowledgment(messageId, ".\myAdministrationQueue")
         End If
         
         Return
   End Sub
      
      
      ' Creates a new queue.

   Public Shared Sub CreateQueue(queuePath As String)
         Try
            If Not MessageQueue.Exists(queuePath) Then
               MessageQueue.Create(queuePath)
            Else
               Console.WriteLine((queuePath + " already exists."))
            End If
         Catch e As MessageQueueException
            Console.WriteLine(e.Message)
         End Try
   End Sub
       
      
      
 
      ' Sends a string message to a queue.
 
   Public Sub SendMessage()
         
         ' Connect to a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         ' Create a new message.
         Dim myMessage As New Message("Original Message")
         
         myMessage.AdministrationQueue = New MessageQueue(".\myAdministrationQueue")
         myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive Or AcknowledgeTypes.PositiveArrival
         
         ' Send the Order to the queue.
         myQueue.Send(myMessage)
         
         Return
   End Sub
      
      
      
 
      ' Receives a message containing an Order.
 
   Public Function ReceiveMessage() As String
         ' Connect to the a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         myQueue.MessageReadPropertyFilter.CorrelationId = True
         
         
         ' Set the formatter to indicate body contains an Order.
         myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(String)})
         
         Dim returnString As String = Nothing
         
         Try
            ' Receive and format the message. 
            Dim myMessage As Message = myQueue.Receive()
            
            
            ' Display message information.
            Console.WriteLine("____________________________________________")
            Console.WriteLine("Original message information--")
            Console.WriteLine(("Body: " + myMessage.Body.ToString()))
            Console.WriteLine(("Id: " + myMessage.Id.ToString()))
            Console.WriteLine("____________________________________________")
            
            returnString = myMessage.Id
         
         
                  
         ' Handle invalid serialization format.
         Catch e As InvalidOperationException
            Console.WriteLine(e.Message)
         End Try
         
         ' Catch other exceptions as necessary.
         Return returnString
   End Function 'ReceiveMessage
      
      
 
      ' Receives a message containing an Order.
 
   Public Sub ReceiveAcknowledgment(messageId As String, queuePath As String)
         Dim found As Boolean = False
         Dim queue As New MessageQueue(queuePath)
         queue.MessageReadPropertyFilter.CorrelationId = True
         queue.MessageReadPropertyFilter.Acknowledgment = True
         
         Try
            While Not (queue.PeekByCorrelationId(messageId) Is Nothing)
               Dim myAcknowledgmentMessage As Message = queue.ReceiveByCorrelationId(messageId)
               
               ' Output acknowledgment message information. The correlation Id is identical
               ' to the id of the original message.
               Console.WriteLine("Acknowledgment Message Information--")
               Console.WriteLine(("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString()))
               Console.WriteLine(("Id: " + myAcknowledgmentMessage.Id.ToString()))
               Console.WriteLine(("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString()))
               Console.WriteLine("____________________________________________")
               
               found = True
            End While
         Catch e As InvalidOperationException
            ' This exception would be thrown if there is no (further) acknowledgment message
            ' with the specified correlation Id. Only output a message if there are no messages;
            ' not if the loop has found at least one.
            If found = False Then
               Console.WriteLine(e.Message)
            End If
         End Try 
   End Sub
 End Class

Этот метод выглядит в очереди, отличной от транзакций, на которую ссылается MessageQueue сообщение, соответствующее CorrelationId указанному correlationId параметру. Если сообщение не найдено, соответствующее параметру correlationID , создается исключение. В противном случае сообщение удаляется из очереди и возвращается в приложение.

Два других метода позволяют получать сообщения из очереди. Метод Receive возвращает первое сообщение в очереди, а ReceiveById(String) метод извлекает сообщение, указав его уникальный идентификатор.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	В наличии
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Нет
Имя удаленного компьютера и прямого формата	Да

См. также раздел

Применяется к

Кері байланыс

Бет пайдалы болды ма?

Бөлісу құралы:

MessageQueue.ReceiveByCorrelationId Метод

Определение

Перегрузки

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

ReceiveByCorrelationId(String, TimeSpan)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

ReceiveByCorrelationId(String, MessageQueueTransactionType)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

ReceiveByCorrelationId(String, MessageQueueTransaction)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

ReceiveByCorrelationId(String)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

Кері байланыс