ReceiveCompletedEventArgs Classe

Définition

Espace de noms:

System.Messaging

Assembly:

System.Messaging.dll

Fournit des données pour l'événement ReceiveCompleted. Lorsque votre opération de réception asynchrone appelle un gestionnaire d'événements, une instance de cette classe est passée au gestionnaire.

public ref class ReceiveCompletedEventArgs : EventArgs

public class ReceiveCompletedEventArgs : EventArgs

type ReceiveCompletedEventArgs = class
    inherit EventArgs

Public Class ReceiveCompletedEventArgs
Inherits EventArgs

Héritage

Object

EventArgs

ReceiveCompletedEventArgs

Exemples

L’exemple de code suivant crée un gestionnaire d’événements pour l’événement ReceiveCompleted et l’associe au délégué d’événement à l’aide de ReceiveCompletedEventHandler. Le gestionnaire d’événements, MyReceiveCompleted, reçoit un message d’une file d’attente et écrit son corps dans l’écran.

#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

Remarques

Lorsque vous utilisez la notification d’événement pour recevoir des messages de façon asynchrone à partir de la file d’attente, vous devez créer une méthode qui gère le traitement de vos messages. Votre code doit appeler BeginReceive pour commencer le traitement asynchrone. Lorsqu’un message est reçu, votre application est avertie par le biais de l’événement ReceiveCompleted . Une instance de est passée au délégué d’événement ReceiveCompletedEventArgs qui appelle votre gestionnaire d’événements. Les données associées à l’événement ReceiveCompleted sont contenues dans le paramètre du AsyncResult délégué.

Il existe deux façons de fournir une notification de fin d’événement : la notification d’événement et les rappels. ReceiveCompletedEventArgs est utilisé uniquement avec la notification d’événement. Pour plus d’informations sur la comparaison des rappels et des notifications d’événements, consultez « Événements et rappels » sur MSDN.

ReceiveCompletedEventArgs fournit l’accès au message qui a lancé la fin de l’opération de réception asynchrone, par le biais du Message membre . Il s’agit d’un autre accès au message et se comporte de la même façon qu’un appel à MessageQueue.EndReceive.

Propriétés

AsyncResult	Obtient ou définit le résultat de l'opération asynchrone demandée.
Message	Obtient le message associé à l'opération de réception asynchrone.

Méthodes

Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

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