ReceiveCompletedEventHandler Delegate

Definition

Namespace:

System.Messaging

Assembly:

System.Messaging.dll

Represents the method that will handle the ReceiveCompleted event of a MessageQueue.

C#

public delegate void ReceiveCompletedEventHandler(object sender, ReceiveCompletedEventArgs e);

Parameters

sender

Object

The source of the event, the MessageQueue.

e

ReceiveCompletedEventArgs

A ReceiveCompletedEventArgs that contains the event data.

Examples

The following code example illustrates how to create an event delegate (ReceiveCompletedEventHandler) for the event handler (MyReceiveCompleted) and associate it with the MessageQueue.ReceiveCompleted event. The event handler receives a message from a queue, and writes its label to the screen.

C#

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;
        }
    }
}

Remarks

When you create a ReceiveCompletedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Handling and Raising Events.

Extension Methods

GetMethodInfo(Delegate)

Gets an object that represents the method represented by the specified delegate.

Applies to

See also

• MessageQueue
• PeekCompletedEventHandler
• ReceiveCompletedEventArgs