MessageQueue.Receive Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Получает первое сообщение в очереди, удаляя его из очереди.
Перегрузки
| Имя | Описание |
|---|---|
| Receive() |
Получает первое сообщение, доступное в очереди, на которую ссылается .MessageQueue Этот вызов синхронен и блокирует текущий поток выполнения до тех пор, пока сообщение не будет доступно. |
| Receive(MessageQueueTransaction) |
Получает первое сообщение, доступное в очереди транзакций, на которое ссылается .MessageQueue Этот вызов синхронен и блокирует текущий поток выполнения до тех пор, пока сообщение не будет доступно. |
| Receive(MessageQueueTransactionType) |
Получает первое сообщение, доступное в очереди, на которую ссылается .MessageQueue Этот вызов синхронен и блокирует текущий поток выполнения до тех пор, пока сообщение не будет доступно. |
| Receive(TimeSpan) |
Получает первое сообщение, доступное в очереди, на которое ссылается MessageQueue ссылка, и ожидает, пока сообщение не будет доступно в очереди или истекает время ожидания. |
| Receive(TimeSpan, Cursor) |
Получает текущее сообщение в очереди с помощью указанного курсора. Если сообщение недоступно, этот метод ожидает, пока не будет доступно сообщение или истекает время ожидания. |
| Receive(TimeSpan, MessageQueueTransaction) |
Получает первое сообщение, доступное в очереди транзакций, на которое ссылается MessageQueue и ожидает, пока сообщение не будет доступно в очереди или истекает время ожидания. |
| Receive(TimeSpan, MessageQueueTransactionType) |
Получает первое сообщение, доступное в очереди, на которую ссылается .MessageQueue Этот вызов синхронен и ожидает, пока сообщение не будет доступно в очереди или истекает время ожидания. |
| Receive(TimeSpan, Cursor, MessageQueueTransaction) |
Получает текущее сообщение в очереди с помощью указанного курсора. Если сообщение недоступно, этот метод ожидает, пока не будет доступно сообщение или истекает время ожидания. |
| Receive(TimeSpan, Cursor, MessageQueueTransactionType) |
Получает текущее сообщение в очереди с помощью указанного курсора. Если сообщение недоступно, этот метод ожидает, пока не будет доступно сообщение или истекает время ожидания. |
Receive()
Получает первое сообщение, доступное в очереди, на которую ссылается .MessageQueue Этот вызов синхронен и блокирует текущий поток выполнения до тех пор, пока сообщение не будет доступно.
public:
System::Messaging::Message ^ Receive();
public System.Messaging.Message Receive();
member this.Receive : unit -> System.Messaging.Message
Public Function Receive () As Message
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Произошла ошибка при доступе к методу очереди сообщений.
Примеры
В следующем примере кода появляется сообщение из очереди и выводится информация об этом сообщении на экран.
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
// This class represents an object the following example
// sends to a queue and receives from a queue.
ref class Order
{
public:
int orderId;
DateTime orderTime;
};
/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
public:
//*************************************************
// Sends an Order to a queue.
//*************************************************
void SendMessage()
{
// Create a new order and set values.
Order^ sentOrder = gcnew Order;
sentOrder->orderId = 3;
sentOrder->orderTime = DateTime::Now;
// Connect to a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
// Send the Order to the queue.
myQueue->Send( sentOrder );
return;
}
//*************************************************
// Receives a message containing an Order.
//*************************************************
void ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
// Set the formatter to indicate body contains an Order.
array<Type^>^p = gcnew array<Type^>(1);
p[ 0 ] = Order::typeid;
myQueue->Formatter = gcnew XmlMessageFormatter( p );
try
{
// Receive and format the message.
Message^ myMessage = myQueue->Receive();
Order^ myOrder = static_cast<Order^>(myMessage->Body);
// Display message information.
Console::WriteLine( "Order ID: {0}", myOrder->orderId );
Console::WriteLine( "Sent: {0}", myOrder->orderTime );
}
catch ( MessageQueueException^ )
{
// Handle Message Queuing exceptions.
}
// Handle invalid serialization format.
catch ( InvalidOperationException^ e )
{
Console::WriteLine( e->Message );
}
// Catch other exceptions as necessary.
return;
}
};
//*************************************************
// Provides an entry point into the application.
//
// This example sends and receives a message from
// a queue.
//*************************************************
int main()
{
// Create a new instance of the class.
MyNewQueue^ myNewQueue = gcnew MyNewQueue;
// Send a message to a queue.
myNewQueue->SendMessage();
// Receive a message from a queue.
myNewQueue->ReceiveMessage();
return 0;
}
using System;
using System.Messaging;
namespace MyProject
{
// This class represents an object the following example
// sends to a queue and receives from a queue.
public class Order
{
public int orderId;
public DateTime orderTime;
};
/// <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();
// Send a message to a queue.
myNewQueue.SendMessage();
// Receive a message from a queue.
myNewQueue.ReceiveMessage();
return;
}
//**************************************************
// Sends an Order to a queue.
//**************************************************
public void SendMessage()
{
// Create a new order and set values.
Order sentOrder = new Order();
sentOrder.orderId = 3;
sentOrder.orderTime = DateTime.Now;
// Connect to a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
// Send the Order to the queue.
myQueue.Send(sentOrder);
return;
}
//**************************************************
// Receives a message containing an Order.
//**************************************************
public void ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
// Set the formatter to indicate body contains an Order.
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(MyProject.Order)});
try
{
// Receive and format the message.
Message myMessage = myQueue.Receive();
Order myOrder = (Order)myMessage.Body;
// Display message information.
Console.WriteLine("Order ID: " +
myOrder.orderId.ToString());
Console.WriteLine("Sent: " +
myOrder.orderTime.ToString());
}
catch (MessageQueueException)
{
// Handle Message Queuing exceptions.
}
// Handle invalid serialization format.
catch (InvalidOperationException e)
{
Console.WriteLine(e.Message);
}
// Catch other exceptions as necessary.
return;
}
}
}
Imports System.Messaging
' This class represents an object the following example
' sends to a queue and receives from a queue.
Public Class Order
Public orderId As Integer
Public orderTime As DateTime
End Class
Public Class MyNewQueue
'
' Provides an entry point into the application.
'
' This example sends and receives a message from
' a qeue.
'
Public Shared Sub Main()
' Create a new instance of the class.
Dim myNewQueue As New MyNewQueue()
' Send a message to a queue.
myNewQueue.SendMessage()
' Receive a message from a queue.
myNewQueue.ReceiveMessage()
Return
End Sub
'
' Sends an Order to a queue.
'
Public Sub SendMessage()
' Create a new order and set values.
Dim sentOrder As New Order()
sentOrder.orderId = 3
sentOrder.orderTime = DateTime.Now
' Connect to a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Send the Order to the queue.
myQueue.Send(sentOrder)
Return
End Sub
'
' Receives a message containing an Order.
'
Public Sub ReceiveMessage()
' Connect to the a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Set the formatter to indicate the body contains an Order.
myQueue.Formatter = New XmlMessageFormatter(New Type() _
{GetType(Order)})
Try
' Receive and format the message.
Dim myMessage As Message = myQueue.Receive()
Dim myOrder As Order = CType(myMessage.Body, Order)
' Display message information.
Console.WriteLine(("Order ID: " + _
myOrder.orderId.ToString()))
Console.WriteLine(("Sent: " + _
myOrder.orderTime.ToString()))
Catch m As MessageQueueException
' Handle Message Queuing exceptions.
Catch e As InvalidOperationException
' Handle invalid serialization format.
Console.WriteLine(e.Message)
' Catch other exceptions as necessary.
End Try
Return
End Sub
End Class
Комментарии
Используйте эту перегрузку для получения сообщения из очереди или ожидания, пока в очереди есть сообщения.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы Receive будут возвращать сообщения, которые следуют в очереди или новые, более высокие приоритеты.
Чтобы прочитать первое сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Метод Peek всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Так как эта перегрузка Receive метода указывает бесконечное время ожидания, приложение может ждать неограниченное время ожидания. Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(MessageQueueTransaction)
Получает первое сообщение, доступное в очереди транзакций, на которое ссылается .MessageQueue Этот вызов синхронен и блокирует текущий поток выполнения до тех пор, пока сообщение не будет доступно.
public:
System::Messaging::Message ^ Receive(System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message Receive(System.Messaging.MessageQueueTransaction transaction);
member this.Receive : System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function Receive (transaction As MessageQueueTransaction) As Message
Параметры
- transaction
- MessageQueueTransaction
Объект MessageQueueTransaction.
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Произошла ошибка при доступе к методу очереди сообщений.
–или–
Очередь не является транзакционной.
Примеры
Следующий пример кода подключается к транзакционной очереди на локальном компьютере и отправляет сообщение в очередь. Затем он получает сообщение, содержащее заказ. Если она встречает очередь, не относясь к транзакциям, она вызовет и исключение и откат транзакции.
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
public:
//*************************************************
// Sends a message to a queue.
//*************************************************
void SendMessageTransactional()
{
// Connect to a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myTransactionalQueue" );
// Send a message to the queue.
if ( myQueue->Transactional )
{
// Create a transaction.
MessageQueueTransaction^ myTransaction = gcnew MessageQueueTransaction;
// Begin the transaction.
myTransaction->Begin();
// Send the message.
myQueue->Send( "My Message Data.", myTransaction );
// Commit the transaction.
myTransaction->Commit();
}
return;
}
//*************************************************
// Receives a message containing an Order.
//*************************************************
void ReceiveMessageTransactional()
{
// Connect to a transactional queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myTransactionalQueue" );
// Set the formatter.
array<Type^>^p = gcnew array<Type^>(1);
p[ 0 ] = String::typeid;
myQueue->Formatter = gcnew XmlMessageFormatter( p );
// Create a transaction.
MessageQueueTransaction^ myTransaction = gcnew MessageQueueTransaction;
try
{
// Begin the transaction.
myTransaction->Begin();
// Receive the message.
Message^ myMessage = myQueue->Receive( myTransaction );
String^ myOrder = static_cast<String^>(myMessage->Body);
// Display message information.
Console::WriteLine( myOrder );
// Commit the transaction.
myTransaction->Commit();
}
catch ( MessageQueueException^ e )
{
// Handle nontransactional queues.
if ( e->MessageQueueErrorCode == MessageQueueErrorCode::TransactionUsage )
{
Console::WriteLine( "Queue is not transactional." );
}
// Else catch other sources of a MessageQueueException.
// Roll back the transaction.
myTransaction->Abort();
}
// Catch other exceptions as necessary, such as
// InvalidOperationException, thrown when the formatter
// cannot deserialize the message.
return;
}
};
//*************************************************
// Provides an entry point into the application.
//
// This example sends and receives a message from
// a transactional queue.
//*************************************************
int main()
{
// Create a new instance of the class.
MyNewQueue^ myNewQueue = gcnew MyNewQueue;
// Send a message to a queue.
myNewQueue->SendMessageTransactional();
// Receive a message from a queue.
myNewQueue->ReceiveMessageTransactional();
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 transactional queue.
//**************************************************
public static void Main()
{
// Create a new instance of the class.
MyNewQueue myNewQueue = new MyNewQueue();
// Send a message to a queue.
myNewQueue.SendMessageTransactional();
// Receive a message from a queue.
myNewQueue.ReceiveMessageTransactional();
return;
}
//**************************************************
// Sends a message to a queue.
//**************************************************
public void SendMessageTransactional()
{
// Connect to a queue on the local computer.
MessageQueue myQueue = new
MessageQueue(".\\myTransactionalQueue");
// Send a message to the queue.
if (myQueue.Transactional)
{
// Create a transaction.
MessageQueueTransaction myTransaction = new
MessageQueueTransaction();
// Begin the transaction.
myTransaction.Begin();
// Send the message.
myQueue.Send("My Message Data.", myTransaction);
// Commit the transaction.
myTransaction.Commit();
}
return;
}
//**************************************************
// Receives a message containing an Order.
//**************************************************
public void ReceiveMessageTransactional()
{
// Connect to a transactional queue on the local computer.
MessageQueue myQueue = new
MessageQueue(".\\myTransactionalQueue");
// Set the formatter.
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(String)});
// Create a transaction.
MessageQueueTransaction myTransaction = new
MessageQueueTransaction();
try
{
// Begin the transaction.
myTransaction.Begin();
// Receive the message.
Message myMessage = myQueue.Receive(myTransaction);
String myOrder = (String)myMessage.Body;
// Display message information.
Console.WriteLine(myOrder);
// Commit the transaction.
myTransaction.Commit();
}
catch (MessageQueueException e)
{
// Handle nontransactional queues.
if (e.MessageQueueErrorCode ==
MessageQueueErrorCode.TransactionUsage)
{
Console.WriteLine("Queue is not transactional.");
}
// Else catch other sources of a MessageQueueException.
// Roll back the transaction.
myTransaction.Abort();
}
// Catch other exceptions as necessary, such as
// InvalidOperationException, thrown when the formatter
// cannot deserialize the message.
return;
}
}
}
Imports System.Messaging
Public Class MyNewQueue
'
' Provides an entry point into the application.
'
' This example sends and receives a message from
' a transactional queue.
'
Public Shared Sub Main()
' Create a new instance of the class.
Dim myNewQueue As New MyNewQueue
' Send a message to a queue.
myNewQueue.SendMessageTransactional()
' Receive a message from a queue.
myNewQueue.ReceiveMessageTransactional()
Return
End Sub
'
' Sends a message to a queue.
'
Public Sub SendMessageTransactional()
' Connect to a queue on the local computer.
Dim myQueue As New MessageQueue(".\myTransactionalQueue")
' Send a message to the queue.
If myQueue.Transactional = True Then
' Create a transaction.
Dim myTransaction As New MessageQueueTransaction
' Begin the transaction.
myTransaction.Begin()
' Send the message.
myQueue.Send("My Message Data.", myTransaction)
' Commit the transaction.
myTransaction.Commit()
End If
Return
End Sub
'
' Receives a message containing an Order.
'
Public Sub ReceiveMessageTransactional()
' Connect to a transactional queue on the local computer.
Dim myQueue As New MessageQueue(".\myTransactionalQueue")
' Set the formatter.
myQueue.Formatter = New XmlMessageFormatter(New Type() _
{GetType([String])})
' Create a transaction.
Dim myTransaction As New MessageQueueTransaction
Try
' Begin the transaction.
myTransaction.Begin()
' Receive the message.
Dim myMessage As Message = _
myQueue.Receive(myTransaction)
Dim myOrder As [String] = CType(myMessage.Body, _
[String])
' Display message information.
Console.WriteLine(myOrder)
' Commit the transaction.
myTransaction.Commit()
Catch e As MessageQueueException
' Handle nontransactional queues.
If e.MessageQueueErrorCode = _
MessageQueueErrorCode.TransactionUsage Then
Console.WriteLine("Queue is not transactional.")
End If
' Else catch other sources of a MessageQueueException.
' Roll back the transaction.
myTransaction.Abort()
' Catch other exceptions as necessary, such as
' InvalidOperationException, thrown when the formatter
' cannot deserialize the message.
End Try
Return
End Sub
End Class
Комментарии
Используйте эту перегрузку для получения сообщения из очереди транзакций с помощью внутреннего контекста транзакции, определенного transaction параметром, или дождитесь появления сообщений в очереди.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы Receive будут возвращать сообщения, которые следуют в очереди.
Так как этот метод вызывается в очереди транзакций, полученное сообщение будет возвращено в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.
Чтобы прочитать первое сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Метод Peek всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом. Контекст транзакции не связан с сообщением, возвращаемым вызовом Peek. Так как Peek не удаляет сообщения в очереди, не будет ничего, чтобы откатить Abortвызов.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Так как эта перегрузка Receive метода указывает бесконечное время ожидания, приложение может ждать неограниченное время ожидания. Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(MessageQueueTransactionType)
Получает первое сообщение, доступное в очереди, на которую ссылается .MessageQueue Этот вызов синхронен и блокирует текущий поток выполнения до тех пор, пока сообщение не будет доступно.
public:
System::Messaging::Message ^ Receive(System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message Receive(System.Messaging.MessageQueueTransactionType transactionType);
member this.Receive : System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function Receive (transactionType As MessageQueueTransactionType) As Message
Параметры
- transactionType
- MessageQueueTransactionType
Одно из MessageQueueTransactionType значений, описывающее тип контекста транзакции для связывания с сообщением.
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Произошла ошибка при доступе к методу очереди сообщений.
Параметр transactionType не является одним из MessageQueueTransactionType членов.
Примеры
В следующем примере кода показано использование Receive(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, MessageQueueTransactionType::Single);
// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));
// Set the formatter to indicate the message body contains a String.
queue->Formatter = gcnew XmlMessageFormatter(
gcnew array<Type^>{String::typeid});
// Receive the message from the queue. Because the Id of the message
// , it might not be the message just sent.
msg = queue->Receive(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, MessageQueueTransactionType.Single);
// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));
// Set the formatter to indicate the message body contains a String.
queue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(String)});
// Receive the message from the queue. Because the Id of the message
// , it might not be the message just sent.
msg = queue.Receive(MessageQueueTransactionType.Single);
Комментарии
Используйте эту перегрузку для получения сообщения из очереди с помощью контекста транзакции, определенного transactionType параметром, или дождитесь появления сообщений в очереди.
Укажите Automatic для transactionType параметра, если уже есть внешний контекст транзакции, подключенный к потоку, который вы хотите использовать для получения сообщения. Укажите Single , хотите ли вы получить сообщение как одну внутреннюю транзакцию. Можно указать None , нужно ли получать сообщение из очереди транзакций за пределами контекста транзакции.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы Receive будут возвращать сообщения, которые следуют в очереди.
Если этот метод вызывается для получения сообщения из очереди транзакций, полученное сообщение будет возвращено в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.
Чтобы прочитать первое сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Метод Peek всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом. Контекст транзакции не связан с сообщением, возвращаемым вызовом Peek. Так как Peek не удаляет сообщения в очереди, не будет ничего, чтобы откатить Abortвызов.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Так как эта перегрузка Receive метода указывает бесконечное время ожидания, приложение может ждать неограниченное время ожидания. Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(TimeSpan)
Получает первое сообщение, доступное в очереди, на которое ссылается MessageQueue ссылка, и ожидает, пока сообщение не будет доступно в очереди или истекает время ожидания.
public:
System::Messaging::Message ^ Receive(TimeSpan timeout);
public System.Messaging.Message Receive(TimeSpan timeout);
member this.Receive : TimeSpan -> System.Messaging.Message
Public Function Receive (timeout As TimeSpan) As Message
Параметры
- timeout
- TimeSpan
Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.
Сообщение не поступило в очередь до истечения срока ожидания.
–или–
Ошибка при доступе к методу очереди сообщений
Примеры
В следующем примере кода появляется сообщение из очереди и выводится информация об этом сообщении на экран. Пример приостанавливает выполнение до пяти секунд, ожидая прибытия сообщения в очередь.
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
// This class represents an object the following example
// receives from a queue.
ref class Order
{
public:
int orderId;
DateTime orderTime;
};
/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
public:
//*************************************************
// Receives a message containing an Order.
//*************************************************
void ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
// Set the formatter to indicate body contains an Order.
array<Type^>^p = gcnew array<Type^>(1);
p[ 0 ] = Order::typeid;
myQueue->Formatter = gcnew XmlMessageFormatter( p );
try
{
// Receive and format the message.
// Wait 5 seconds for a message to arrive.
Message^ myMessage = myQueue->Receive( TimeSpan(0,0,5) );
Order^ myOrder = static_cast<Order^>(myMessage->Body);
// Display message information.
Console::WriteLine( "Order ID: {0}", myOrder->orderId );
Console::WriteLine( "Sent: {0}", myOrder->orderTime );
}
catch ( MessageQueueException^ e )
{
// Handle no message arriving in the queue.
if ( e->MessageQueueErrorCode == MessageQueueErrorCode::IOTimeout )
{
Console::WriteLine( "No message arrived in queue." );
}
// Handle other sources of a MessageQueueException.
}
// Handle invalid serialization format.
catch ( InvalidOperationException^ e )
{
Console::WriteLine( e->Message );
}
// Catch other exceptions as necessary.
return;
}
};
//*************************************************
// Provides an entry point into the application.
//
// This example receives a message from a queue.
//*************************************************
int main()
{
// Create a new instance of the class.
MyNewQueue^ myNewQueue = gcnew MyNewQueue;
// Receive a message from a queue.
myNewQueue->ReceiveMessage();
return 0;
}
using System;
using System.Messaging;
namespace MyProject
{
// This class represents an object the following example
// receives from a queue.
public class Order
{
public int orderId;
public DateTime orderTime;
};
/// <summary>
/// Provides a container class for the example.
/// </summary>
public class MyNewQueue
{
//**************************************************
// Provides an entry point into the application.
//
// This example receives a message from a queue.
//**************************************************
public static void Main()
{
// Create a new instance of the class.
MyNewQueue myNewQueue = new MyNewQueue();
// Receive a message from a queue.
myNewQueue.ReceiveMessage();
return;
}
//**************************************************
// Receives a message containing an Order.
//**************************************************
public void ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
// Set the formatter to indicate body contains an Order.
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(MyProject.Order)});
try
{
// Receive and format the message.
// Wait 5 seconds for a message to arrive.
Message myMessage = myQueue.Receive(new
TimeSpan(0,0,5));
Order myOrder = (Order)myMessage.Body;
// Display message information.
Console.WriteLine("Order ID: " +
myOrder.orderId.ToString());
Console.WriteLine("Sent: " +
myOrder.orderTime.ToString());
}
catch (MessageQueueException e)
{
// Handle no message arriving in the queue.
if (e.MessageQueueErrorCode ==
MessageQueueErrorCode.IOTimeout)
{
Console.WriteLine("No message arrived in queue.");
}
// Handle other sources of a MessageQueueException.
}
// Handle invalid serialization format.
catch (InvalidOperationException e)
{
Console.WriteLine(e.Message);
}
// Catch other exceptions as necessary.
return;
}
}
}
Imports System.Messaging
' This class represents an object the following example
' receives from a queue.
Public Class Order
Public orderId As Integer
Public orderTime As DateTime
End Class
Public Class MyNewQueue
'
' Provides an entry point into the application.
'
' This example receives a message from a queue.
'
Public Shared Sub Main()
' Create a new instance of the class.
Dim myNewQueue As New MyNewQueue()
' Receive a message from a queue.
myNewQueue.ReceiveMessage()
Return
End Sub
'
' Receives a message containing an Order.
'
Public Sub ReceiveMessage()
' Connect to the a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Set the formatter to indicate body contains an Order.
myQueue.Formatter = New XmlMessageFormatter(New Type() _
{GetType(Order)})
Try
' Receive and format the message.
' Wait 5 seconds for a message to arrive.
Dim myMessage As Message = myQueue.Receive(New _
TimeSpan(0, 0, 5))
Dim myOrder As Order = CType(myMessage.Body, Order)
' Display message information.
Console.WriteLine(("Order ID: " + _
myOrder.orderId.ToString()))
Console.WriteLine(("Sent: " + _
myOrder.orderTime.ToString()))
Catch e As MessageQueueException
' Handle no message arriving in the queue.
If e.MessageQueueErrorCode = _
MessageQueueErrorCode.IOTimeout Then
Console.WriteLine("No message arrived in queue.")
End If
' Handle other sources of a MessageQueueException.
Catch e As InvalidOperationException
' Handle invalid serialization format.
Console.WriteLine(e.Message)
' Catch other exceptions as necessary.
End Try
Return
End Sub
End Class
Комментарии
Используйте эту перегрузку для получения сообщения и возврата в указанный период времени, если в очереди нет сообщений.
Метод Receive позволяет синхронно считывать сообщение, удалив его из очереди. Последующие вызовы Receive будут возвращать сообщения, которые следуют в очереди или новые, более высокие приоритеты.
Чтобы прочитать первое сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Метод Peek всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Поток будет заблокирован в течение заданного периода времени или на неопределенный срок, если вы указали значение InfiniteTimeout параметра timeout . Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(TimeSpan, Cursor)
Получает текущее сообщение в очереди с помощью указанного курсора. Если сообщение недоступно, этот метод ожидает, пока не будет доступно сообщение или истекает время ожидания.
public:
System::Messaging::Message ^ Receive(TimeSpan timeout, System::Messaging::Cursor ^ cursor);
public System.Messaging.Message Receive(TimeSpan timeout, System.Messaging.Cursor cursor);
member this.Receive : TimeSpan * System.Messaging.Cursor -> System.Messaging.Message
Public Function Receive (timeout As TimeSpan, cursor As Cursor) As Message
Параметры
- timeout
- TimeSpan
Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.
Сообщение не поступило в очередь до истечения срока ожидания.
–или–
Ошибка при доступе к методу очереди сообщений
Используйте эту перегрузку для получения сообщения и возврата в указанный период времени, если в очереди нет сообщений.
Применяется к
Receive(TimeSpan, MessageQueueTransaction)
Получает первое сообщение, доступное в очереди транзакций, на которое ссылается MessageQueue и ожидает, пока сообщение не будет доступно в очереди или истекает время ожидания.
public:
System::Messaging::Message ^ Receive(TimeSpan timeout, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message Receive(TimeSpan timeout, System.Messaging.MessageQueueTransaction transaction);
member this.Receive : TimeSpan * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function Receive (timeout As TimeSpan, transaction As MessageQueueTransaction) As Message
Параметры
- timeout
- TimeSpan
Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.
- transaction
- MessageQueueTransaction
Объект MessageQueueTransaction.
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.
Сообщение не поступило в очередь до истечения срока ожидания.
–или–
Очередь не является транзакционной.
–или–
Произошла ошибка при доступе к методу очереди сообщений.
Примеры
В следующем примере кода демонстрируется использование этого метода.
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
public:
//*************************************************
// Sends a message to a transactional queue.
//*************************************************
void SendMessageTransactional()
{
// Connect to a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myTransactionalQueue" );
// Send a message to the queue.
if ( myQueue->Transactional)
{
// Create a transaction.
MessageQueueTransaction^ myTransaction = gcnew MessageQueueTransaction;
// Begin the transaction.
myTransaction->Begin();
// Send the message.
myQueue->Send( "My Message Data.", myTransaction );
// Commit the transaction.
myTransaction->Commit();
}
return;
}
//*************************************************
// Receives a message from the transactional queue.
//*************************************************
void ReceiveMessageTransactional()
{
// Connect to a transactional queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myTransactionalQueue" );
// Set the formatter.
array<Type^>^p = gcnew array<Type^>(1);
p[ 0 ] = String::typeid;
myQueue->Formatter = gcnew XmlMessageFormatter( p );
// Create a transaction.
MessageQueueTransaction^ myTransaction = gcnew MessageQueueTransaction;
try
{
// Begin the transaction.
myTransaction->Begin();
// Receive the message.
// Wait five seconds for a message to arrive.
Message^ myMessage = myQueue->Receive( TimeSpan(0,0,5), myTransaction );
String^ myOrder = static_cast<String^>(myMessage->Body);
// Display message information.
Console::WriteLine( myOrder );
// Commit the transaction.
myTransaction->Commit();
}
catch ( MessageQueueException^ e )
{
// Handle nontransactional queues.
if ( e->MessageQueueErrorCode == MessageQueueErrorCode::TransactionUsage )
{
Console::WriteLine( "Queue is not transactional." );
}
// Handle no message arriving in the queue.
else
// Handle no message arriving in the queue.
if ( e->MessageQueueErrorCode == MessageQueueErrorCode::IOTimeout )
{
Console::WriteLine( "No message in queue." );
}
// Else catch other sources of MessageQueueException.
// Roll back the transaction.
myTransaction->Abort();
}
// Catch other exceptions as necessary, such as
// InvalidOperationException, thrown when the formatter
// cannot deserialize the message.
return;
}
};
//*************************************************
// Provides an entry point into the application.
//
// This example sends and receives a message from
// a transactional queue.
//*************************************************
int main()
{
// Create a new instance of the class.
MyNewQueue^ myNewQueue = gcnew MyNewQueue;
// Send a message to a queue.
myNewQueue->SendMessageTransactional();
// Receive a message from a queue.
myNewQueue->ReceiveMessageTransactional();
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 transactional queue.
//**************************************************
public static void Main()
{
// Create a new instance of the class.
MyNewQueue myNewQueue = new MyNewQueue();
// Send a message to a queue.
myNewQueue.SendMessageTransactional();
// Receive a message from a queue.
myNewQueue.ReceiveMessageTransactional();
return;
}
//**************************************************
// Sends a message to a transactional queue.
//**************************************************
public void SendMessageTransactional()
{
// Connect to a queue on the local computer.
MessageQueue myQueue = new
MessageQueue(".\\myTransactionalQueue");
// Send a message to the queue.
if (myQueue.Transactional)
{
// Create a transaction.
MessageQueueTransaction myTransaction = new
MessageQueueTransaction();
// Begin the transaction.
myTransaction.Begin();
// Send the message.
myQueue.Send("My Message Data.", myTransaction);
// Commit the transaction.
myTransaction.Commit();
}
return;
}
//**************************************************
// Receives a message from the transactional queue.
//**************************************************
public void ReceiveMessageTransactional()
{
// Connect to a transactional queue on the local computer.
MessageQueue myQueue = new
MessageQueue(".\\myTransactionalQueue");
// Set the formatter.
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(String)});
// Create a transaction.
MessageQueueTransaction myTransaction = new
MessageQueueTransaction();
try
{
// Begin the transaction.
myTransaction.Begin();
// Receive the message.
// Wait five seconds for a message to arrive.
Message myMessage = myQueue.Receive(new
TimeSpan(0,0,5), myTransaction);
String myOrder = (String)myMessage.Body;
// Display message information.
Console.WriteLine(myOrder);
// Commit the transaction.
myTransaction.Commit();
}
catch (MessageQueueException e)
{
// Handle nontransactional queues.
if (e.MessageQueueErrorCode ==
MessageQueueErrorCode.TransactionUsage)
{
Console.WriteLine("Queue is not transactional.");
}
// Handle no message arriving in the queue.
else if (e.MessageQueueErrorCode ==
MessageQueueErrorCode.IOTimeout)
{
Console.WriteLine("No message in queue.");
}
// Else catch other sources of MessageQueueException.
// Roll back the transaction.
myTransaction.Abort();
}
// Catch other exceptions as necessary, such as
// InvalidOperationException, thrown when the formatter
// cannot deserialize the message.
return;
}
}
}
Imports System.Messaging
Namespace MyProj
Public Class MyNewQueue
'**************************************************
' Provides an entry point into the application.
'
' This example sends and receives a message from
' a transactional queue.
'**************************************************
Public Shared Sub Main()
' Create a new instance of the class.
Dim myNewQueue As New MyNewQueue
' Send a message to a queue.
myNewQueue.SendMessageTransactional()
' Receive a message from a queue.
myNewQueue.ReceiveMessageTransactional()
Return
End Sub
'**************************************************
' Sends a message to a transactional queue.
'**************************************************
Public Sub SendMessageTransactional()
' Connect to a queue on the local computer.
Dim myQueue As New MessageQueue(".\myTransactionalQueue")
' Send a message to the queue.
If myQueue.Transactional = True Then
' Create a transaction.
Dim myTransaction As New MessageQueueTransaction
' Begin the transaction.
myTransaction.Begin()
' Send the message.
myQueue.Send("My Message Data.", myTransaction)
' Commit the transaction.
myTransaction.Commit()
End If
Return
End Sub
'**************************************************
' Receives a message from the transactional queue.
'**************************************************
Public Sub ReceiveMessageTransactional()
' Connect to a transactional queue on the local computer.
Dim myQueue As New MessageQueue(".\myTransactionalQueue")
' Set the formatter.
myQueue.Formatter = New XmlMessageFormatter(New Type() _
{GetType([String])})
' Create a transaction.
Dim myTransaction As New MessageQueueTransaction
Try
' Begin the transaction.
myTransaction.Begin()
' Receive the message.
' Wait five seconds for a message to arrive.
Dim myMessage As Message = myQueue.Receive(New _
TimeSpan(0, 0, 5), myTransaction)
Dim myOrder As [String] = CType(myMessage.Body, _
[String])
' Display message information.
Console.WriteLine(myOrder)
' Commit the transaction.
myTransaction.Commit()
Catch e As MessageQueueException
' Handle nontransactional queues.
If e.MessageQueueErrorCode = _
MessageQueueErrorCode.TransactionUsage Then
Console.WriteLine("Queue is not transactional.")
Else
' Handle no message arriving in the queue.
If e.MessageQueueErrorCode = _
MessageQueueErrorCode.IOTimeout Then
Console.WriteLine("No message in queue.")
End If
End If
' Else catch other sources of a MessageQueueException.
' Roll back the transaction.
myTransaction.Abort()
' Catch other exceptions as necessary, such as InvalidOperationException,
' thrown when the formatter cannot deserialize the message.
End Try
Return
End Sub
End Class
End Namespace 'MyProj
Комментарии
Используйте эту перегрузку для получения сообщения из очереди транзакций с помощью внутреннего контекста транзакции, определенного transaction параметром, и возвращайте в течение указанного периода времени, если в очереди нет сообщений.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы Receive будут возвращать сообщения, которые следуют в очереди.
Так как этот метод вызывается в очереди транзакций, полученное сообщение будет возвращено в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.
Чтобы прочитать первое сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Метод Peek всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом. Контекст транзакции не связан с сообщением, возвращаемым вызовом Peek. Так как Peek не удаляет сообщения в очереди, не будет ничего, чтобы откатить Abortвызов.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Поток будет заблокирован в течение заданного периода времени или на неопределенный срок, если вы указали значение InfiniteTimeout параметра timeout . Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(TimeSpan, MessageQueueTransactionType)
Получает первое сообщение, доступное в очереди, на которую ссылается .MessageQueue Этот вызов синхронен и ожидает, пока сообщение не будет доступно в очереди или истекает время ожидания.
public:
System::Messaging::Message ^ Receive(TimeSpan timeout, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message Receive(TimeSpan timeout, System.Messaging.MessageQueueTransactionType transactionType);
member this.Receive : TimeSpan * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function Receive (timeout As TimeSpan, transactionType As MessageQueueTransactionType) As Message
Параметры
- timeout
- TimeSpan
Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.
- transactionType
- MessageQueueTransactionType
Одно из MessageQueueTransactionType значений, описывающее тип контекста транзакции для связывания с сообщением.
Возвращаемое значение
Ответ, Message ссылающийся на первое сообщение, доступное в очереди.
Исключения
Значение, указанное timeout для параметра, недопустимо, возможно timeout , меньше Zero или больше InfiniteTimeout.
Параметр transactionType не является одним из 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, MessageQueueTransactionType::Single);
// Set the formatter to indicate the message body contains a String.
queue->Formatter = gcnew XmlMessageFormatter(
gcnew array<Type^>{String::typeid});
// Receive the message from the queue. Because the Id of the message
// is not specified, it might not be the message just sent.
msg = queue->Receive(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, MessageQueueTransactionType.Single);
// Set the formatter to indicate the message body contains a String.
queue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(String)});
// Receive the message from the queue. Because the Id of the message
// is not specified, it might not be the message just sent.
msg = queue.Receive(TimeSpan.FromSeconds(10.0),
MessageQueueTransactionType.Single);
Комментарии
Используйте эту перегрузку для получения сообщения из очереди с помощью контекста транзакции, определенного transactionType параметром, и возвращается в указанный период времени, если в очереди нет сообщений.
Укажите Automatic для transactionType параметра, если уже есть внешний контекст транзакции, подключенный к потоку, который вы хотите использовать для получения сообщения. Укажите Single , хотите ли вы получить сообщение как одну внутреннюю транзакцию. Можно указать None , нужно ли получать сообщение из очереди транзакций за пределами контекста транзакции.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы Receive будут возвращать сообщения, которые следуют в очереди.
Если этот метод вызывается для получения сообщения из очереди транзакций, полученное сообщение будет возвращено в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.
Чтобы прочитать первое сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Метод Peek всегда возвращает первое сообщение в очереди, поэтому последующие вызовы метода возвращают то же сообщение, если в очередь не поступает сообщение с более высоким приоритетом. Контекст транзакции не связан с сообщением, возвращаемым вызовом Peek. Так как Peek не удаляет сообщения в очереди, не будет ничего, чтобы откатить Abortвызов.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Поток будет заблокирован в течение заданного периода времени или на неопределенный срок, если вы указали значение InfiniteTimeout параметра timeout . Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(TimeSpan, Cursor, MessageQueueTransaction)
Получает текущее сообщение в очереди с помощью указанного курсора. Если сообщение недоступно, этот метод ожидает, пока не будет доступно сообщение или истекает время ожидания.
public:
System::Messaging::Message ^ Receive(TimeSpan timeout, System::Messaging::Cursor ^ cursor, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message Receive(TimeSpan timeout, System.Messaging.Cursor cursor, System.Messaging.MessageQueueTransaction transaction);
member this.Receive : TimeSpan * System.Messaging.Cursor * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function Receive (timeout As TimeSpan, cursor As Cursor, transaction As MessageQueueTransaction) As Message
Параметры
- timeout
- TimeSpan
Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.
- transaction
- MessageQueueTransaction
Объект MessageQueueTransaction.
Возвращаемое значение
Объект, Message ссылающийся на сообщение в очереди.
Исключения
Параметр cursor имеет значение null.
–или–
Параметр transaction имеет значение null.
Для параметра timeout указано недопустимое значение.
timeout Возможно, меньше Zero или большеInfiniteTimeout.
Сообщение не поступило в очередь до истечения срока ожидания.
–или–
Очередь не является транзакционной.
–или–
Произошла ошибка при доступе к методу очереди сообщений.
Комментарии
Используйте эту перегрузку для получения сообщения из очереди транзакций с помощью внутреннего контекста транзакции, определенного transaction параметром, и возвращайте в течение указанного периода времени, если в очереди нет сообщений.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы для Receive возврата сообщений, которые следуют в очереди.
Так как этот метод вызывается в очереди транзакций, полученное сообщение возвращается в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.
Чтобы прочитать сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Контекст транзакции не связан с сообщением, возвращаемым вызовом Peek. Так как Peek не удаляет сообщения в очереди, нет ничего, чтобы откатить Abortвызов.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Поток блокируется в течение заданного периода времени или на неопределенный срок, если вы указали значение InfiniteTimeout параметра timeout . Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Receive(TimeSpan, Cursor, MessageQueueTransactionType)
Получает текущее сообщение в очереди с помощью указанного курсора. Если сообщение недоступно, этот метод ожидает, пока не будет доступно сообщение или истекает время ожидания.
public:
System::Messaging::Message ^ Receive(TimeSpan timeout, System::Messaging::Cursor ^ cursor, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message Receive(TimeSpan timeout, System.Messaging.Cursor cursor, System.Messaging.MessageQueueTransactionType transactionType);
member this.Receive : TimeSpan * System.Messaging.Cursor * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function Receive (timeout As TimeSpan, cursor As Cursor, transactionType As MessageQueueTransactionType) As Message
Параметры
- timeout
- TimeSpan
Значение TimeSpan , указывающее время ожидания, пока новое сообщение не будет доступно для проверки.
- transactionType
- MessageQueueTransactionType
Одно из MessageQueueTransactionType значений, описывающих тип контекста транзакции для связи с сообщением.
Возвращаемое значение
Объект, Message ссылающийся на сообщение в очереди.
Исключения
Параметр cursor имеет значение null.
Для параметра timeout указано недопустимое значение.
timeout Возможно, меньше Zero или большеInfiniteTimeout.
Параметр transactionType не является одним из MessageQueueTransactionType членов.
Сообщение не поступило в очередь до истечения срока ожидания.
–или–
Произошла ошибка при доступе к методу очереди сообщений.
Комментарии
Используйте эту перегрузку для получения сообщения из очереди с помощью контекста транзакции, определенного transactionType параметром, и возвращается в указанный период времени, если в очереди нет сообщений.
Укажите Automatic для transactionType параметра, если уже есть внешний контекст транзакции, подключенный к потоку, который вы хотите использовать для получения сообщения. Укажите Single , хотите ли вы получить сообщение как одну внутреннюю транзакцию. Можно указать None , нужно ли получать сообщение из очереди транзакций за пределами контекста транзакции.
Метод Receive позволяет синхронно считывать сообщение, тем самым удаляя его из очереди. Последующие вызовы для Receive возврата сообщений, которые следуют в очереди.
Если этот метод вызывается для получения сообщения из очереди транзакций, то полученное сообщение возвращается в очередь, если транзакция прервана. Сообщение не удаляется окончательно из очереди, пока транзакция не будет зафиксирована.
Чтобы прочитать сообщение в очереди, не удаляя его из очереди, используйте Peek метод. Контекст транзакции не связан с сообщением, возвращаемым вызовом Peek. Так как Peek не удаляет сообщения в очереди, нет ничего, чтобы откатить Abortвызов.
Используйте вызов Receive , когда он может быть заблокирован текущим потоком, пока он ожидает прибытия сообщения в очередь. Поток блокируется в течение заданного периода времени или на неопределенный срок, если вы указали значение InfiniteTimeout параметра timeout . Если обработка приложения должна продолжаться без ожидания сообщения, рассмотрите возможность использования асинхронного метода BeginReceive.
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
| Режим рабочей группы | В наличии |
|---|---|
| Локальный компьютер | Yes |
| Имя локального компьютера и прямого формата | Yes |
| Удаленный компьютер | Нет |
| Имя удаленного компьютера и прямого формата | Yes |
См. также раздел
Применяется к
Потокобезопасность
Метод не является потокобезопасной.