MessageQueue.ReceiveCompleted Event

Occurs when a message has been removed from the queue. This event is raised by the asynchronous operation, BeginReceive.

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

[MessagingDescriptionAttribute("MQ_ReceiveCompleted")]
public event ReceiveCompletedEventHandler ReceiveCompleted

BeginReceive is used in asynchronous processing to raise the ReceiveCompleted event when a message is available in the queue.

EndReceive(IAsyncResult) is used to complete the operation initiated by a call to BeginReceive and peek the message when the ReceiveCompleted event is raised.

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 Events and Delegates.

The following code example creates an event handler named MyReceiveCompleted, attaches it to the ReceiveCompleted event handler delegate, and calls BeginReceive to initiate an asynchronous receive operation on the queue that is located at the path ".\myQueue". When a ReceiveCompleted event is raised, the example receives the message and writes its body to the screen. The example then calls BeginReceive again to initiate a new asynchronous receive operation.

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; 
		}
	}
}
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

__gc class MyNewQueue 
{
	//*************************************************
	// Provides an event handler for the ReceiveCompleted
	// event.
	//*************************************************
public:
	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(S"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 = new MessageQueue(S".\\myQueue");

	Type* p __gc[] = new Type* __gc[1];
	p[0] = __typeof(String);
	myQueue->Formatter = new XmlMessageFormatter( p );

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

	// Begin the asynchronous receive operation.
	myQueue->BeginReceive();

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

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft