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)
The ReceiveCompletedEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
.gif?cs-save-lang=1&cs-lang=vb "Public property") | AsyncResult | Gets or sets the result of the asynchronous operation requested. |
| Message | Gets the message associated with the asynchronous receive operation. |
| Name | Description | |
|---|---|---|
.gif?cs-save-lang=1&cs-lang=vb "Public method") | Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
.gif?cs-save-lang=1&cs-lang=vb "Protected method") | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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.
Imports System 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 'Main ' ' 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 'MyReceiveCompleted End Class 'MyNewQueue
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
