MessageQueue.EndReceive(IAsyncResult) Метод

Определение

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

System.Messaging

Сборка:

System.Messaging.dll

Завершает указанную асинхронную операцию получения.

public:
 System::Messaging::Message ^ EndReceive(IAsyncResult ^ asyncResult);

public System.Messaging.Message EndReceive (IAsyncResult asyncResult);

member this.EndReceive : IAsyncResult -> System.Messaging.Message

Public Function EndReceive (asyncResult As IAsyncResult) As Message

Параметры

asyncResult

IAsyncResult

Объект IAsyncResult, определяющий асинхронную операцию получения, которая завершается и из которой извлекается конечный результат.

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

Message

Класс Message, связанный с завершенной асинхронной операцией.

Исключения

ArgumentNullException

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

ArgumentException

Для параметра asyncResult используется неправильный синтаксис.

MessageQueueException

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

Примеры

В следующем примере кода выполняется цепочка асинхронных запросов. Предполагается, что на локальном компьютере есть очередь myQueue. Функция Main начинает асинхронную операцию, которая обрабатывается подпрограммой MyReceiveCompleted . MyReceiveCompleted обрабатывает текущее сообщение и начинает новую асинхронную операцию получения.

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

using namespace System;
using namespace System::Messaging;
using namespace System::Threading;

ref class MyNewQueue
{
public:

   // Define static class members.
   static ManualResetEvent^ signal = gcnew ManualResetEvent( false );
   static int count = 0;

   // Provides an event handler for the ReceiveCompleted
   // event.
   static void MyReceiveCompleted( Object^ source, ReceiveCompletedEventArgs^ asyncResult )
   {
      try
      {
         // Connect to the queue.
         MessageQueue^ mq = dynamic_cast<MessageQueue^>(source);

         // End the asynchronous receive operation.
         mq->EndReceive( asyncResult->AsyncResult );
         count += 1;
         if ( count == 10 )
         {
            signal->Set();
         }

         // Restart the asynchronous receive operation.
         mq->BeginReceive();
      }
      catch ( MessageQueueException^ ) 
      {
         // Handle sources of MessageQueueException.
      }

      // Handle other exceptions.
      return;
   }
};

// Provides an entry point into the application.
//         
// This example performs asynchronous receive
// operation processing.
int main()
{
   // Create an instance of MessageQueue. Set its formatter.
   MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
   array<Type^>^p = gcnew array<Type^>(1);
   p[ 0 ] = String::typeid;
   myQueue->Formatter = gcnew XmlMessageFormatter( p );

   // Add an event handler for the ReceiveCompleted event.
   myQueue->ReceiveCompleted += gcnew ReceiveCompletedEventHandler( MyNewQueue::MyReceiveCompleted );

   // Begin the asynchronous receive operation.
   myQueue->BeginReceive();
   MyNewQueue::signal->WaitOne();

   // Do other work on the current thread.
   return 0;
}

using System;
using System.Messaging;
using System.Threading;

namespace MyProject
{
    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue
    {
        // Define static class members.
        static ManualResetEvent signal = new ManualResetEvent(false);
        static int count = 0;

        //**************************************************
        // Provides an entry point into the application.
        //		
        // This example performs asynchronous receive
        // operation processing.
        //**************************************************

        public static void Main()
        {
            // Create an instance of MessageQueue. Set its formatter.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");
            myQueue.Formatter = new XmlMessageFormatter(new Type[]
                {typeof(String)});

            // Add an event handler for the ReceiveCompleted event.
            myQueue.ReceiveCompleted +=
                new ReceiveCompletedEventHandler(MyReceiveCompleted);
            
            // Begin the asynchronous receive operation.
            myQueue.BeginReceive();

            signal.WaitOne();
            
            // Do other work on the current thread.

            return;
        }

        //***************************************************
        // Provides an event handler for the ReceiveCompleted
        // event.
        //***************************************************
        
        private static void MyReceiveCompleted(Object source,
            ReceiveCompletedEventArgs asyncResult)
        {
            try
            {
                // Connect to the queue.
                MessageQueue mq = (MessageQueue)source;

                // End the asynchronous receive operation.
                Message m = mq.EndReceive(asyncResult.AsyncResult);
                
                count += 1;
                if (count == 10)
                {
                    signal.Set();
                }

                // Restart the asynchronous receive operation.
                mq.BeginReceive();
            }
            catch(MessageQueueException)
            {
                // Handle sources of MessageQueueException.
            }
            
            // Handle other exceptions.
            
            return;
        }
    }
}

Imports System.Messaging
Imports System.Threading




' Provides a container class for the example.

Public Class MyNewQueue

        ' Define static class members.
        Private Shared signal As New ManualResetEvent(False)
        Private Shared count As Integer = 0



        ' Provides an entry point into the application.
        '		 
        ' This example performs asynchronous receive
        ' operation processing.


        Public Shared Sub Main()
            ' Create an instance of MessageQueue. Set its formatter.
            Dim myQueue As New MessageQueue(".\myQueue")
            myQueue.Formatter = New XmlMessageFormatter(New Type() _
                {GetType([String])})

            ' Add an event handler for the ReceiveCompleted event.
            AddHandler myQueue.ReceiveCompleted, AddressOf _
                MyReceiveCompleted

            ' Begin the asynchronous receive operation.
            myQueue.BeginReceive()

            signal.WaitOne()

            ' Do other work on the current thread.

            Return

        End Sub



        ' Provides an event handler for the ReceiveCompleted
        ' event.


        Private Shared Sub MyReceiveCompleted(ByVal [source] As _
            [Object], ByVal asyncResult As ReceiveCompletedEventArgs)

            Try
                ' Connect to the queue.
                Dim mq As MessageQueue = CType([source], MessageQueue)

                ' End the asynchronous receive operation.
                Dim m As Message = _
                    mq.EndReceive(asyncResult.AsyncResult)

                count += 1
                If count = 10 Then
                    signal.Set()
                End If

                ' Restart the asynchronous receive operation.
                mq.BeginReceive()

            Catch
                ' Handle sources of MessageQueueException.

                ' Handle other exceptions.

            End Try

            Return

        End Sub

End Class

Комментарии

При возникновении ReceiveCompleted события завершает операцию, EndReceive(IAsyncResult) инициированную вызовом BeginReceive . Для этого EndReceive(IAsyncResult) получает сообщение.

BeginReceive может указать время ожидания, которое вызывает ReceiveCompleted событие, если истекает время ожидания, прежде чем сообщение появится в очереди. Если время ожидания истекает без сообщения, поступающего в очередь, последующий вызов вызывает EndReceive(IAsyncResult) исключение.

EndReceive(IAsyncResult) используется для чтения (удаления из очереди) сообщения, вызвавшего ReceiveCompleted событие.

Если вы хотите продолжать асинхронно получать сообщения, можно снова вызвать BeginReceive после вызова EndReceive(IAsyncResult).

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

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

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

• BeginReceive()
• ReceiveCompleted