MessageQueue.ReceiveById Метод

Определение

Получает сообщение, которое соответствует заданному идентификатору, удаляя его из очереди.Receives the message that matches the given identifier, removing it from the queue.

Перегрузки

ReceiveById(String)

Получает из нетранзакционной очереди сообщение, которое соответствует заданному идентификатору, и сразу инициирует исключение, если в настоящий момент в очереди нет сообщения с указанным идентификатором.Receives the message that matches the given identifier from a non-transactional queue and immediately raises an exception if no message with the specified identifier currently exists in the queue.

ReceiveById(String, MessageQueueTransaction)

Получает сообщение, которое соответствует заданному идентификатору (из транзакционной очереди), и сразу инициирует исключение, если в настоящий момент в очереди нет сообщения с указанным идентификатором.Receives the message that matches the given identifier (from a transactional queue) and immediately raises an exception if no message with the specified identifier currently exists in the queue.

ReceiveById(String, MessageQueueTransactionType)

Получает сообщение, которое соответствует заданному идентификатору, и сразу инициирует исключение, если в настоящий момент в очереди нет сообщения с указанным идентификатором.Receives the message that matches the given identifier and immediately raises an exception if no message with the specified identifier currently exists in the queue.

ReceiveById(String, TimeSpan)

Получает сообщение, которое соответствует заданному идентификатору (из нетранзакционной очереди), и ожидает, пока в очереди не появится сообщение с указанным идентификатором, или пока не истечет тайм-аут.Receives the message that matches the given identifier (from a non-transactional queue) and waits until either a message with the specified identifier is available in the queue or the time-out expires.

ReceiveById(String, TimeSpan, MessageQueueTransaction)

Получает сообщение, которое соответствует заданному идентификатору (из транзакционной очереди), и ожидает, пока в очереди не появится сообщение с указанным идентификатором, или пока не истечет тайм-аут.Receives the message that matches the given identifier (from a transactional queue) and waits until either a message with the specified identifier is available in the queue or the time-out expires.

ReceiveById(String, TimeSpan, MessageQueueTransactionType)

Получает сообщение, которое соответствует заданному идентификатору, и ожидает, пока в очереди не появится сообщение с указанным идентификатором, или пока не истечет тайм-аут.Receives the message that matches the given identifier and waits until either a message with the specified identifier is available in the queue or the time-out expires.

ReceiveById(String)

Получает из нетранзакционной очереди сообщение, которое соответствует заданному идентификатору, и сразу инициирует исключение, если в настоящий момент в очереди нет сообщения с указанным идентификатором.Receives the message that matches the given identifier from a non-transactional queue and immediately raises an exception if no message with the specified identifier currently exists in the queue.

public:
 System::Messaging::Message ^ ReceiveById(System::String ^ id);
public System.Messaging.Message ReceiveById (string id);
member this.ReceiveById : string -> System.Messaging.Message
Public Function ReceiveById (id As String) As Message

Параметры

id
String

Свойство Id получаемого сообщения.The Id of the message to receive.

Возвраты

Объект Message, свойство Id которого соответствует переданному в объект параметру id.The Message whose Id property matches the id parameter passed in.

Исключения

Параметр id имеет значение null.The id parameter is null.

Не удалось найти сообщение с указанным параметром id.The message with the specified id could not be found.

При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Примеры

В следующем коде показано использование функции ReceiveById(String).The following code example demonstrates the use of ReceiveById(String).


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

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

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

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

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

// Receive the message from the queue.
msg = queue->ReceiveById(id);

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

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

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

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

// Receive the message from the queue.
msg = queue.ReceiveById(id);

Комментарии

Используйте этот метод для чтения сообщения с известным идентификатором и его удаления из очереди.Use this method to read a message with a known identifier and remove it from the queue. Этот метод немедленно создает исключение, если сообщение не находится в очереди.This method throws an exception immediately if the message is not in the queue.

Свойство сообщения является уникальным в рамках организации очереди сообщений, поэтому в очереди должно быть не более одного сообщения, которое соответствует заданному id параметру. IdThe Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id parameter.

Два других метода позволяют принимать сообщения из очереди.Two other methods allow you to receive messages from a queue. Метод возвращает первое сообщение в очереди, ReceiveByCorrelationId(String) а метод используется для получения подтверждения, отчета или созданного приложением ответного сообщения, созданного в результате сообщения, отправленного в очередь. ReceiveThe Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.

Чтобы прочитать сообщение с указанным идентификатором, не удаляя его из очереди, используйте PeekById(String) метод.To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. PeekById(String) Метод всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.The PeekById(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.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.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

Дополнительно

ReceiveById(String, MessageQueueTransaction)

Получает сообщение, которое соответствует заданному идентификатору (из транзакционной очереди), и сразу инициирует исключение, если в настоящий момент в очереди нет сообщения с указанным идентификатором.Receives the message that matches the given identifier (from a transactional queue) and immediately raises an exception if no message with the specified identifier currently exists in the queue.

public:
 System::Messaging::Message ^ ReceiveById(System::String ^ id, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message ReceiveById (string id, System.Messaging.MessageQueueTransaction transaction);
member this.ReceiveById : string * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function ReceiveById (id As String, transaction As MessageQueueTransaction) As Message

Параметры

id
String

Свойство Id получаемого сообщения.The Id of the message to receive.

Возвраты

Объект Message, свойство Id которого соответствует переданному в объект параметру id.The Message whose Id property matches the id parameter passed in.

Исключения

Параметр id имеет значение null.The id parameter is null.

- или --or- Параметр transaction имеет значение null.The transaction parameter is null.

Не удалось найти сообщение с указанным параметром id.The message with the specified id could not be found.

Очередь является нетранзакционной.The queue is non-transactional.

- или --or-

При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Примеры

В следующем коде показано использование функции ReceiveById(String, MessageQueueTransaction).The following code example demonstrates the use of ReceiveById(String, MessageQueueTransaction).


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

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

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

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

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

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

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

    // Receive the message from the queue.
    msg = queue->ReceiveById(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;
    queue->Close();
}


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

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

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

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

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

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

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

    // Receive the message from the queue.
    msg = queue.ReceiveById(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();
}

Комментарии

Этот метод используется для чтения сообщения с известным идентификатором и удаления его из очереди с использованием контекста внутренней транзакции, определенного transaction параметром.Use this method to read a message with a known identifier and remove it from the queue, using the internal transaction context defined by the transaction parameter. Этот метод немедленно создает исключение, если сообщение не находится в очередиThis method throws an exception immediately if the message is not in the queue

Свойство сообщения является уникальным в рамках организации очереди сообщений, поэтому в очереди должно быть не более одного сообщения, которое соответствует заданному id параметру. IdThe Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id 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.

Два других метода позволяют принимать сообщения из очереди.Two other methods allow you to receive messages from a queue. Метод возвращает первое сообщение в очереди, ReceiveByCorrelationId(String) а метод используется для получения подтверждения, отчета или созданного приложением ответного сообщения, созданного в результате сообщения, отправленного в очередь. ReceiveThe Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.

Чтобы прочитать сообщение с указанным идентификатором, не удаляя его из очереди, используйте PeekById(String) метод.To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. PeekById(String) Метод всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.The PeekById(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. Отсутствует контекст транзакции, связанный с сообщением, возвращенным вызовом PeekById(String).There is no transaction context associated with a message returned by a call to PeekById(String). Поскольку PeekById(String) не удаляет сообщения в очереди, откат транзакции будет невозможен, если транзакция была прервана.Because PeekById(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

Дополнительно

ReceiveById(String, MessageQueueTransactionType)

Получает сообщение, которое соответствует заданному идентификатору, и сразу инициирует исключение, если в настоящий момент в очереди нет сообщения с указанным идентификатором.Receives the message that matches the given identifier and immediately raises an exception if no message with the specified identifier currently exists in the queue.

public:
 System::Messaging::Message ^ ReceiveById(System::String ^ id, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message ReceiveById (string id, System.Messaging.MessageQueueTransactionType transactionType);
member this.ReceiveById : string * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function ReceiveById (id As String, transactionType As MessageQueueTransactionType) As Message

Параметры

id
String

Свойство Id получаемого сообщения.The Id of the message to receive.

transactionType
MessageQueueTransactionType

Одно из значений MessageQueueTransactionType, описывающее тип контекста транзакции, связываемого с сообщением.One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

Возвраты

Объект Message, свойство Id которого соответствует переданному в объект параметру id.The Message whose Id property matches the id parameter passed in.

Исключения

Параметр id имеет значение null.The id parameter is null.

Не удалось найти сообщение с указанным параметром id.The message with the specified id could not be found.

Параметр transactionType не является одним из членов MessageQueueTransactionType.The transactionType parameter is not one of the MessageQueueTransactionType members.

При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Примеры

В следующем коде показано использование функции ReceiveById(String, MessageQueueTransactionType).The following code example demonstrates the use of ReceiveById(String, MessageQueueTransactionType).


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

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

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

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

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

// Receive the message from the queue.
msg = queue->ReceiveById(id, MessageQueueTransactionType::Single);

queue->Close();


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

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

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

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

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

// Receive the message from the queue.
msg = queue.ReceiveById(id, MessageQueueTransactionType.Single);

Комментарии

Используйте этот метод для чтения сообщения с известным идентификатором и его удаления из очереди.Use this method to read a message with a known identifier and remove it from the queue. Этот метод немедленно создает исключение, если сообщение не находится в очереди.This method throws an exception immediately if the message is not in the queue. В противном случае сообщение удаляется из очереди и возвращается приложению с помощью контекста транзакции, определенного transactionType параметром.Otherwise, the message is removed from the queue and returned to the application using a transaction context defined by the transactionType parameter.

Укажите Automatic для параметра transactionType , если к потоку, который требуется использовать для получения сообщения, уже присоединен контекст внешней транзакции.Specify Automatic for the transactionType parameter if there is already an external transaction context attached to the thread that you want to use to receive the message. Укажите Single , следует ли получить сообщение как единую внутреннюю транзакцию.Specify Single if you want to receive the message as a single internal transaction. Можно указать None , следует ли получить сообщение из транзакционной очереди за пределами контекста транзакции.You can specify None if you want to receive a message from a transactional queue outside of a transaction context.

Свойство сообщения является уникальным в рамках организации очереди сообщений, поэтому в очереди должно быть не более одного сообщения, которое соответствует заданному id параметру. IdThe Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id parameter. Если сообщение с указанным идентификатором находится в очереди, отличной от связанной с данным MessageQueue экземпляром, сообщение не будет найдено.If the message with the specified identifier is in a queue other than the one associated with this MessageQueue instance, the message will not be found.

Если этот метод вызывается для получения сообщения из транзакционной очереди, полученное сообщение будет возвращено в очередь, если транзакция прервана.If this method is called to receive a message from 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.

Два других метода позволяют принимать сообщения из очереди.Two other methods allow you to receive messages from a queue. Метод возвращает первое сообщение в очереди, ReceiveByCorrelationId(String) а метод используется для получения подтверждения, отчета или созданного приложением ответного сообщения, созданного в результате сообщения, отправленного в очередь. ReceiveThe Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.

Чтобы прочитать сообщение с указанным идентификатором, не удаляя его из очереди, используйте PeekById(String) метод.To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. PeekById(String) Метод всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.The PeekById(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. Отсутствует контекст транзакции, связанный с сообщением, возвращенным вызовом PeekById(String).There is no transaction context associated with a message returned by a call to PeekById(String). Поскольку PeekById(String) не удаляет сообщения в очереди, откат транзакции будет невозможен, если транзакция была прервана.Because PeekById(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

Дополнительно

ReceiveById(String, TimeSpan)

Получает сообщение, которое соответствует заданному идентификатору (из нетранзакционной очереди), и ожидает, пока в очереди не появится сообщение с указанным идентификатором, или пока не истечет тайм-аут.Receives the message that matches the given identifier (from a non-transactional queue) and waits until either a message with the specified identifier is available in the queue or the time-out expires.

public:
 System::Messaging::Message ^ ReceiveById(System::String ^ id, TimeSpan timeout);
public System.Messaging.Message ReceiveById (string id, TimeSpan timeout);
member this.ReceiveById : string * TimeSpan -> System.Messaging.Message
Public Function ReceiveById (id As String, timeout As TimeSpan) As Message

Параметры

id
String

Свойство Id получаемого сообщения.The Id of the message to receive.

timeout
TimeSpan

Структура TimeSpan, показывающая время ожидания нового сообщения для проверки.A TimeSpan that indicates the time to wait until a new message is available for inspection.

Возвраты

Объект Message, свойство Id которого соответствует переданному в объект параметру id.The Message whose Id property matches the id parameter passed in.

Исключения

Параметр id имеет значение null.The id parameter is null.

Для параметра timeout задано недопустимое значение; возможно, значение параметра timeout меньше Zero или больше InfiniteTimeout.The value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

Сообщение с указанным значением параметра id до истечения тайм-аута в очередь не поступало.A message with the specified id did not arrive in the queue before the time-out expired.

- или --or- При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Примеры

В следующем коде показано использование функции ReceiveById(String, TimeSpan).The following code example demonstrates the use of ReceiveById(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");

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

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

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

Комментарии

Используйте этот метод для чтения сообщения с известным идентификатором и его удаления из очереди.Use this method to read a message with a known identifier and remove it from the queue. Этот метод немедленно возвращает значение, если сообщение с идентификатором, указанным id в параметре, находится в очереди.This method returns immediately if the message with the identifier specified by the id parameter is in the queue. В противном случае метод ожидает поступления нового сообщения в течение заданного периода времени.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.

timeout Параметр не задает общее время выполнения для этого метода.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. Каждый раз, когда поступает новое сообщение, этот метод проверяет Id новое сообщение, чтобы проверить, id соответствует ли он параметру.Each time a new message arrives, this method examines the Id of the new message to see if it matches the id parameter. В противном случае этот метод запускает период времени ожидания и ожидает поступления другого нового сообщения.If not, this method starts the time-out period over and waits for another new message to arrive. Таким образом, если новые сообщения продолжают поступать в течение времени ожидания, этот метод может продолжать работу в течение неограниченного времени, пока не истечет время ожидания, не прибегая новых сообщений или пока не поступит сообщение, для Id которого id соответствует параметру.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 Id matches the id parameter.

Свойство сообщения является уникальным в рамках организации очереди сообщений, поэтому в очереди должно быть не более одного сообщения, которое соответствует заданному id параметру. IdThe Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id parameter.

Используйте эту перегрузку, ReceiveById(String) если допускается блокировка текущего потока при условии, что новые сообщения продолжают поступать в очередь в течение времени ожидания, заданного timeout параметром.Use this overload of ReceiveById(String) when it is acceptable for the current thread to be blocked as long as new messages continue to arrive in the queue within the time-out period specified by the timeout parameter. Поток будет заблокирован по крайней мере в заданный период времени или неопределенно, если указано значение InfiniteTimeout timeout параметра или если новые сообщения продолжают поступать в очередь в течение времени timeout ожидания, заданного параметром параметр.The thread will be blocked for at least the given period of time, or indefinitely if you specified the value InfiniteTimeout for the timeout parameter, or if new messages continue to arrive in the queue within the time-out period specified by the timeout parameter.

Два других метода позволяют принимать сообщения из очереди.Two other methods allow you to receive messages from a queue. Метод возвращает первое сообщение в очереди, ReceiveByCorrelationId(String) а метод используется для получения подтверждения, отчета или созданного приложением ответного сообщения, созданного в результате сообщения, отправленного в очередь. ReceiveThe Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.

Чтобы прочитать сообщение с указанным идентификатором, не удаляя его из очереди, используйте PeekById(String) метод.To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. PeekById(String) Метод всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.The PeekById(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.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.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

Дополнительно

ReceiveById(String, TimeSpan, MessageQueueTransaction)

Получает сообщение, которое соответствует заданному идентификатору (из транзакционной очереди), и ожидает, пока в очереди не появится сообщение с указанным идентификатором, или пока не истечет тайм-аут.Receives the message that matches the given identifier (from a transactional queue) and waits until either a message with the specified identifier is available in the queue or the time-out expires.

public:
 System::Messaging::Message ^ ReceiveById(System::String ^ id, TimeSpan timeout, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message ReceiveById (string id, TimeSpan timeout, System.Messaging.MessageQueueTransaction transaction);
member this.ReceiveById : string * TimeSpan * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function ReceiveById (id As String, timeout As TimeSpan, transaction As MessageQueueTransaction) As Message

Параметры

id
String

Свойство Id получаемого сообщения.The Id of the message to receive.

timeout
TimeSpan

Структура TimeSpan, показывающая время ожидания нового сообщения для проверки.A TimeSpan that indicates the time to wait until a new message is available for inspection.

Возвраты

Объект Message, свойство Id которого соответствует переданному в объект параметру id.The Message whose Id property matches the id parameter passed in.

Исключения

Параметр id имеет значение null.The id parameter is null.

- или --or- Параметр transaction имеет значение null.The transaction parameter is null.

Для параметра timeout задано недопустимое значение; возможно, значение параметра timeout меньше Zero или больше InfiniteTimeout.The value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

Сообщение с указанным значением параметра id до истечения тайм-аута в очередь не поступало.A message with the specified id did not arrive in the queue before the time-out expired.

- или --or- Очередь является нетранзакционной.The queue is non-transactional.

- или --or- При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Примеры

В следующем коде показано использование функции ReceiveById(String, TimeSpan, MessageQueueTransaction).The following code example demonstrates the use of ReceiveById(String, TimeSpan, MessageQueueTransaction).


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

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

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

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

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

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

    // Receive the message from the queue.
    msg = queue->ReceiveById(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;
    queue->Close();
}


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

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

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

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

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

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

    // Receive the message from the queue.
    msg = queue.ReceiveById(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();
}

Комментарии

Этот метод используется для чтения сообщения с известным идентификатором и удаления его из очереди с использованием контекста внутренней транзакции, определенного transaction параметром.Use this method to read a message with a known identifier and remove it from the queue, using the internal transaction context defined by the transaction parameter. Этот метод немедленно возвращает значение, если сообщение с идентификатором, указанным id в параметре, находится в очереди.This method returns immediately if the message with the identifier specified by the id parameter is in the queue. В противном случае метод ожидает поступления нового сообщения в течение заданного периода времени.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.

timeout Параметр не задает общее время выполнения для этого метода.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. Каждый раз, когда поступает новое сообщение, этот метод проверяет Id новое сообщение, чтобы проверить, id соответствует ли он параметру.Each time a new message arrives, this method examines the Id of the new message to see if it matches the id parameter. В противном случае этот метод запускает период времени ожидания и ожидает поступления другого нового сообщения.If not, this method starts the time-out period over and waits for another new message to arrive. Таким образом, если новые сообщения продолжают поступать в течение времени ожидания, этот метод может продолжать работу в течение неограниченного времени, пока не истечет время ожидания, не прибегая новых сообщений или пока не поступит сообщение, для Id которого id соответствует параметру.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 Id matches the id parameter.

Свойство сообщения является уникальным в рамках организации очереди сообщений, поэтому в очереди должно быть не более одного сообщения, которое соответствует заданному id параметру. IdThe Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id parameter.

Используйте эту перегрузку, ReceiveById(String) если допускается блокировка текущего потока при условии, что новые сообщения продолжают поступать в очередь в течение времени ожидания, заданного timeout параметром.Use this overload of ReceiveById(String) when it is acceptable for the current thread to be blocked as long as new messages continue to arrive in the queue within the time-out period specified by the timeout parameter. Поток будет заблокирован по крайней мере в заданный период времени или неопределенно, если указано значение InfiniteTimeout timeout параметра или если новые сообщения продолжают поступать в очередь в течение timeout времени ожидания, заданного параметром параметр.The thread will be blocked for at least the given period of time, or indefinitely if you specified the value InfiniteTimeout for the timeout parameter, or if new messages continue to arrive in the queue within the timeout period specified by the timeout 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.

Два других метода позволяют принимать сообщения из очереди.Two other methods allow you to receive messages from a queue. Метод возвращает первое сообщение в очереди, ReceiveByCorrelationId(String) а метод используется для получения подтверждения, отчета или созданного приложением ответного сообщения, созданного в результате сообщения, отправленного в очередь. ReceiveThe Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.

Чтобы прочитать сообщение с указанным идентификатором, не удаляя его из очереди, используйте PeekById(String) метод.To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. PeekById(String) Метод всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают одно и то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.The PeekById(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. Отсутствует контекст транзакции, связанный с сообщением, возвращенным вызовом PeekById(String).There is no transaction context associated with a message returned by a call to PeekById(String). Поскольку PeekById(String) не удаляет сообщения в очереди, откат транзакции будет невозможен, если транзакция была прервана.Because PeekById(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

Дополнительно

ReceiveById(String, TimeSpan, MessageQueueTransactionType)

Получает сообщение, которое соответствует заданному идентификатору, и ожидает, пока в очереди не появится сообщение с указанным идентификатором, или пока не истечет тайм-аут.Receives the message that matches the given identifier and waits until either a message with the specified identifier is available in the queue or the time-out expires.

public:
 System::Messaging::Message ^ ReceiveById(System::String ^ id, TimeSpan timeout, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message ReceiveById (string id, TimeSpan timeout, System.Messaging.MessageQueueTransactionType transactionType);
member this.ReceiveById : string * TimeSpan * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function ReceiveById (id As String, timeout As TimeSpan, transactionType As MessageQueueTransactionType) As Message

Параметры

id
String

Свойство Id получаемого сообщения.The Id of the message to receive.

timeout
TimeSpan

Структура TimeSpan, показывающая время ожидания нового сообщения для проверки.A TimeSpan that indicates the time to wait until a new message is available for inspection.

transactionType
MessageQueueTransactionType

Одно из значений MessageQueueTransactionType, описывающее тип контекста транзакции, связываемого с сообщением.One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

Возвраты

Объект Message, свойство Id которого соответствует переданному в объект параметру id.The Message whose Id property matches the id parameter passed in.

Исключения

Параметр id имеет значение null.The id parameter is null.

Для параметра timeout задано недопустимое значение; возможно, значение параметра timeout меньше Zero или больше InfiniteTimeout.The value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

Сообщение с указанным значением параметра id до истечения тайм-аута в очередь не поступало.A message with the specified id did not arrive in the queue before the time-out expired.

-или--or- При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Параметр transactionType не является одним из членов MessageQueueTransactionType.The transactionType parameter is not one of the MessageQueueTransactionType members.

Примеры

В следующем коде показано использование функции ReceiveById(String, TimeSpan, MessageQueueTransactionType).The following code example demonstrates the use of ReceiveById(String, TimeSpan, MessageQueueTransactionType).


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

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

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

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

queue->Close();


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

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

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

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

Комментарии

Используйте этот метод для чтения сообщения с известным идентификатором и его удаления из очереди.Use this method to read a message with a known identifier and remove it from the queue. Этот метод немедленно возвращает значение, если сообщение с идентификатором, указанным id в параметре, находится в очереди, с использованием контекста транзакции, transactionType определенного параметром.This method returns immediately if the message with the identifier specified by the id parameter is in the queue, using a transaction context defined by the transactionType 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.

timeout Параметр не задает общее время выполнения для этого метода.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. Каждый раз, когда поступает новое сообщение, этот метод проверяет Id новое сообщение, чтобы проверить, id соответствует ли он параметру.Each time a new message arrives, this method examines the Id of the new message to see if it matches the id parameter. В противном случае этот метод запускает период времени ожидания и ожидает поступления другого нового сообщения.If not, this method starts the time-out period over and waits for another new message to arrive. Таким образом, если новые сообщения продолжают поступать в течение времени ожидания, этот метод может продолжать работу в течение неограниченного времени, пока не истечет время ожидания, не прибегая новых сообщений или пока не поступит сообщение, для Id которого id соответствует параметру.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 Id matches the id parameter.

Укажите Automatic для параметра transactionType , если к потоку, который требуется использовать для получения сообщения, уже присоединен контекст внешней транзакции.Specify Automatic for the transactionType parameter if there is already an external transaction context attached to the thread that you want to use to receive the message. Укажите Single , следует ли получить сообщение как единую внутреннюю транзакцию.Specify Single if you want to receive the message as a single internal transaction. Можно указать None , следует ли получить сообщение из транзакционной очереди за пределами контекста транзакции.You can specify None if you want to receive a message from a transactional queue outside of a transaction context.

Свойство сообщения является уникальным в рамках организации очереди сообщений, поэтому в очереди должно быть не более одного сообщения, которое соответствует заданному id параметру. IdThe Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id parameter. Если сообщение с указанным идентификатором находится в очереди, отличной от связанной с данным MessageQueue экземпляром, сообщение не будет найдено.If the message with the specified identifier is in a queue other than the one associated with this MessageQueue instance, the message will not be found.

Используйте эту перегрузку, ReceiveById(String) если допускается блокировка текущего потока при условии, что новые сообщения продолжают поступать в очередь в течение времени ожидания, заданного timeout параметром.Use this overload of ReceiveById(String) when it is acceptable for the current thread to be blocked as long as new messages continue to arrive in the queue within the time-out period specified by the timeout parameter. Поток будет заблокирован по крайней мере в заданный период времени или неопределенно, если указано значение InfiniteTimeout timeout параметра или если новые сообщения продолжают поступать в очередь в течение времени timeout ожидания, заданного параметром параметр.The thread will be blocked for at least the given period of time, or indefinitely if you specified the value InfiniteTimeout for the timeout parameter, or if new messages continue to arrive in the queue within the time-out period specified by the timeout parameter.

Если этот метод вызывается для получения сообщения из транзакционной очереди, полученное сообщение будет возвращено в очередь, если транзакция прервана.If this method is called to receive a message from 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.

Два других метода позволяют принимать сообщения из очереди.Two other methods allow you to receive messages from a queue. Метод возвращает первое сообщение в очереди, ReceiveByCorrelationId(String) а метод используется для получения подтверждения, отчета или созданного приложением ответного сообщения, созданного в результате сообщения, отправленного в очередь. ReceiveThe Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.

Чтобы прочитать сообщение с указанным идентификатором, не удаляя его из очереди, используйте PeekById(String) метод.To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. PeekById(String) Метод всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.The PeekById(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. Отсутствует контекст транзакции, связанный с сообщением, возвращенным вызовом PeekById(String).There is no transaction context associated with a message returned by a call to PeekById(String). Поскольку PeekById(String) не удаляет сообщения в очереди, откат транзакции будет невозможен, если транзакция была прервана.Because PeekById(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

Дополнительно

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