MessageQueue::ReceiveCompleted Event
Occurs when a message has been removed from the queue. This event is raised by the asynchronous operation, BeginReceive.
Assembly: System.Messaging (in System.Messaging.dll)
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.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; }
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.