MessageQueue.PeekCompleted Event


Occurs when a message is read without being removed from the queue. This is a result of the asynchronous operation, BeginPeek.

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

Public Event PeekCompleted As PeekCompletedEventHandler

BeginPeek is used in asynchronous processing to raise the PeekCompleted event when a message is available in the queue.

EndPeek(IAsyncResult) is used to complete the operation initiated by a call to BeginPeek and peek the message when the PeekCompleted event is raised.

When you create a PeekCompletedEventHandler 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 NIB: Events and Delegates.

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

Imports System
Imports System.Messaging

' Provides a container class for the example.
Public Class MyNewQueue

        ' Provides an entry point into the application.
        ' This example performs asynchronous peek 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() _

            ' Add an event handler for the PeekCompleted event.
            AddHandler myQueue.PeekCompleted, AddressOf _

            ' Begin the asynchronous peek operation.

            ' Do other work on the current thread.
        End Sub 'Main

        ' Provides an event handler for the PeekCompleted
        ' event.

        Private Shared Sub MyPeekCompleted(ByVal [source] As _
            [Object], ByVal asyncResult As PeekCompletedEventArgs)

            ' Connect to the queue.
            Dim mq As MessageQueue = CType([source], MessageQueue)

            ' End the asynchronous peek operation.
            Dim m As Message = mq.EndPeek(asyncResult.AsyncResult)

            ' Display message information on the screen.
            Console.WriteLine(("Message: " + CStr(m.Body)))

            ' Restart the asynchronous peek operation.


        End Sub 'MyPeekCompleted

End Class 'MyNewQueue

.NET Framework
Available since 1.1
Return to top