ReceiveCompletedEventArgs Класс

Определение

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

System.Messaging

Сборка:

System.Messaging.dll

Предоставляет данные для события ReceiveCompleted. Когда асинхронная операция получения вызывает обработчик событий, экземпляр этого класса передается в обработчик.

public ref class ReceiveCompletedEventArgs : EventArgs

public class ReceiveCompletedEventArgs : EventArgs

type ReceiveCompletedEventArgs = class
    inherit EventArgs

Public Class ReceiveCompletedEventArgs
Inherits EventArgs

Наследование

Object

EventArgs

ReceiveCompletedEventArgs

Примеры

В следующем примере кода создается обработчик событий для ReceiveCompleted события и связывается с делегатом события с помощью ReceiveCompletedEventHandler. Обработчик MyReceiveCompletedсобытий получает сообщение из очереди и записывает его текст на экран.

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

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:

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

      // End the asynchronous Receive operation.
      Message^ m = mq->EndReceive( asyncResult->AsyncResult );

      // Display message information on the screen.
      Console::WriteLine( "Message: {0}", m->Body );

      // Restart the asynchronous Receive operation.
      mq->BeginReceive();
      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();

   // Do other work on the current thread.
   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 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();
            
            // Do other work on the current thread.

            return;
        }

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

            // End the asynchronous Receive operation.
            Message m = mq.EndReceive(asyncResult.AsyncResult);

            // Display message information on the screen.
            Console.WriteLine("Message: " + (string)m.Body);

            // Restart the asynchronous Receive operation.
            mq.BeginReceive();
            
            return;
        }
    }
}

Imports System.Messaging

Public Class MyNewQueue


        '
        ' 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()

            ' 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)

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

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

            ' Display message information on the screen.
            Console.WriteLine(("Message: " + CStr(m.Body)))

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

            Return

        End Sub

End Class

Комментарии

При использовании уведомления о событиях для асинхронного получения сообщений из очереди необходимо создать метод, обрабатывающий обработку сообщений. Код должен вызвать BeginReceive , чтобы начать асинхронную обработку. При получении сообщения приложение получает уведомление через ReceiveCompleted событие . Экземпляр ReceiveCompletedEventArgs передается делегату события, который вызывает обработчик событий. Данные, связанные с событием ReceiveCompleted , содержатся в параметре делегата AsyncResult .

Существует два способа предоставления уведомлений о завершении события: уведомления о событиях и обратные вызовы. ReceiveCompletedEventArgs используется только с уведомлением о событиях. Сведения о сравнении обратных вызовов и уведомлений о событиях см. в разделе "События и обратные вызовы" на сайте MSDN.

ReceiveCompletedEventArgs предоставляет доступ к сообщению, которое инициировало конец асинхронной операции получения, через Message член . Это альтернативный доступ к сообщению и ведет себя почти так же, как вызов MessageQueue.EndReceive.

Свойства

AsyncResult	Получает или задает результат запрошенной асинхронной операции.
Message	Получает сообщение, связанное с данной асинхронной операцией получения.

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

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

• MessageQueue
• ReceiveCompletedEventHandler
• ReceiveCompleted
• BeginReceive()
• EndReceive(IAsyncResult)
• Message