Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ReceiveCompletedEventArgs Class

Provides data for the ReceiveCompleted event. When your asynchronous receive operation calls an event handler, an instance of this class is passed to the handler.

Namespace: System.Messaging
Assembly: System.Messaging (in system.messaging.dll)

public class ReceiveCompletedEventArgs : EventArgs
public class ReceiveCompletedEventArgs extends EventArgs
public class ReceiveCompletedEventArgs extends EventArgs

When you use event notification to receive messages asynchronously from the queue, you must create a method that handles your message processing. Your code must call BeginReceive to begin the asynchronous processing. When a message is received, your application is notified through the ReceiveCompleted event. An instance of ReceiveCompletedEventArgs is passed into the event delegate that calls your event handler. The data associated with the ReceiveCompleted event is contained in the delegate's AsyncResult parameter.

There are two ways to provide notification of event completion: event notification and callbacks. ReceiveCompletedEventArgs is used only with event notification. For information comparing callbacks and event notification, see "Events vs. Callbacks" on MSDN.

ReceiveCompletedEventArgs provides access to the message that initiated the end of the asynchronous receive operation, through the Message member. This is an alternate access to the message, and behaves much the same as a call to MessageQueue.EndReceive.

The following code example creates an event handler for the ReceiveCompleted event and associates it with the event delegate by using the ReceiveCompletedEventHandler. The event handler, MyReceiveCompleted, receives a message from a queue and writes its body to the screen.

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

package MyProject;

import System.*;
import System.Messaging.*;

/// <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(String[] args)
    {
        // Create an instance of MessageQueue. Set its formatter.
        MessageQueue myQueue = new MessageQueue(".\\myQueue");
        myQueue.set_Formatter(new XmlMessageFormatter(new Type[]
            { String.class.ToType() }));
        // Add an event handler for the ReceiveCompleted event.
        myQueue.add_ReceiveCompleted(new ReceiveCompletedEventHandler
            (MyReceiveCompleted));
        // Begin the asynchronous receive operation.
        myQueue.BeginReceive();
        // Do other work on the current thread.
        return;
    } //main

    //**************************************************
    // 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.get_AsyncResult());
        // Display message information on the screen.
        Console.WriteLine("Message: " + (String)(m.get_Body()));
        // Restart the asynchronous Receive operation.
        mq.BeginReceive();
        return;
    } //MyReceiveCompleted
} //MyNewQueue

System.Object
   System.EventArgs
    System.Messaging.ReceiveCompletedEventArgs
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.