MessageQueue.BeginPeek Methode

public:
 IAsyncResult ^ BeginPeek(TimeSpan timeout, System::Object ^ stateObject, AsyncCallback ^ callback);

public IAsyncResult BeginPeek(TimeSpan timeout, object stateObject, AsyncCallback callback);

member this.BeginPeek : TimeSpan * obj * AsyncCallback -> IAsyncResult

Public Function BeginPeek (timeout As TimeSpan, stateObject As Object, callback As AsyncCallback) As IAsyncResult

Parameter

Gibt zurück

Dies IAsyncResult identifiziert die bereitgestellte asynchrone Anforderung.

Ausnahmen

Beispiele

Im folgenden Codebeispiel wird ein asynchroner Vorschauvorgang erstellt. Im Codebeispiel wird eine Nachricht an eine lokale Nachrichtenwarteschlange gesendet. Anschließend wird ein Timeoutwert von zehn Sekunden aufgerufenBeginPeek(TimeSpan, Object, AsyncCallback), eine eindeutige ganze Zahl, die diese bestimmte Nachricht identifiziert, und eine neue Instanz, die AsyncCallback den Ereignishandler identifiziert. MyPeekCompleted Wenn ein PeekCompleted Ereignis ausgelöst wird, führt der Ereignishandler einen Blick auf die Nachricht und schreibt den Nachrichtentext und den ganzzahligen Nachrichtenbezeichner auf den Bildschirm.

#using <System.Messaging.dll>
#using <System.dll>

using namespace System;
using namespace System::Messaging;

// Creates a new queue.
void CreateQueue(String^ queuePath, bool transactional)
{
    if(!MessageQueue::Exists(queuePath))
    {
        MessageQueue^ queue = MessageQueue::Create(queuePath, transactional);
        queue->Close();      
    }
    else
    {
        Console::WriteLine("{0} already exists.", queuePath);
    }
}

// Provides an event handler for the PeekCompleted event.
void MyPeekCompleted(IAsyncResult^ asyncResult)
{
    // Connect to the queue.
    MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");

    // End the asynchronous peek operation.
    Message^ msg = queue->EndPeek(asyncResult);

    // Display the message information on the screen.
    Console::WriteLine("Message number: {0}", asyncResult->AsyncState);
    Console::WriteLine("Message body: {0}", msg->Body);

    // Receive the message. This will remove the message from the queue.
    msg = queue->Receive(TimeSpan::FromSeconds(10.0));

    queue->Close();
}

int main()
{
    // Represents a state object associated with each message.
    int messageNumber = 0;

    // Create a non-transactional queue on the local computer.
    // Note that the queue might not be immediately accessible, and
    // therefore this example might throw an exception of type
    // System.Messaging.MessageQueueException when trying to send a
    // message to the newly created queue.
    CreateQueue(".\\exampleQueue", false);

    // Connect to a queue on the local computer.
    MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");

    // Send a message to the queue.
    queue->Send("Example Message");

    // Begin the asynchronous peek operation.
    queue->BeginPeek(TimeSpan::FromSeconds(10.0), messageNumber++,
        gcnew AsyncCallback(MyPeekCompleted));

    // Simulate doing other work on the current thread.
    System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));

    queue->Close();
}

using System;
using System.Messaging;

public class QueueExample
{
    // Represents a state object associated with each message.
    static int messageNumber = 0;

    public static void Main()
    {
        // Create a non-transactional queue on the local computer.
        // Note that the queue might not be immediately accessible, and
        // therefore this example might throw an exception of type
        // System.Messaging.MessageQueueException when trying to send a
        // message to the newly created queue.
        CreateQueue(".\\exampleQueue", false);

        // Connect to a queue on the local computer.
        MessageQueue queue = new MessageQueue(".\\exampleQueue");

        // Send a message to the queue.
        queue.Send("Example Message");

        // Begin the asynchronous peek operation.
        queue.BeginPeek(TimeSpan.FromSeconds(10.0), messageNumber++,
            new AsyncCallback(MyPeekCompleted));

        // Simulate doing other work on the current thread.
        System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));

        return;
    }

    // Creates a new queue.
    public static void CreateQueue(string queuePath, bool transactional)
    {
        if(!MessageQueue.Exists(queuePath))
        {
            MessageQueue.Create(queuePath, transactional);
        }
        else
        {
            Console.WriteLine(queuePath + " already exists.");
        }
    }

    // Provides an event handler for the PeekCompleted event.
    private static void MyPeekCompleted(IAsyncResult asyncResult)
    {
        // Connect to the queue.
        MessageQueue queue = new MessageQueue(".\\exampleQueue");

        // End the asynchronous peek operation.
        Message msg = queue.EndPeek(asyncResult);

        // Display the message information on the screen.
        Console.WriteLine("Message number: {0}", (int)asyncResult.AsyncState);
        Console.WriteLine("Message body: {0}", (string)msg.Body);

        // Receive the message. This will remove the message from the queue.
        msg = queue.Receive(TimeSpan.FromSeconds(10.0));
    }
}

Hinweise

Wenn Sie diese Überladung verwenden, wird der im Rückrufparameter angegebene Rückruf direkt aufgerufen, wenn eine Nachricht in der Warteschlange verfügbar wird oder wenn das angegebene Zeitintervall abgelaufen ist; das PeekCompleted Ereignis wird nicht ausgelöst. Die anderen Überladungen, die BeginPeek von dieser Komponente abhängen, um das PeekCompleted Ereignis auszuheben.

PeekCompleted wird auch ausgelöst, wenn in der Warteschlange bereits eine Nachricht vorhanden ist.

Die BeginPeek Methode gibt sofort zurück, aber der asynchrone Vorgang wird erst abgeschlossen, wenn der Ereignishandler aufgerufen wird.

Da BeginPeek asynchron ist, können Sie die Warteschlange aufrufen, ohne den aktuellen Ausführungsthread zu blockieren. Verwenden Sie die Peek Methode, um die Warteschlange synchron anzuzeigen.

Sobald ein asynchroner Vorgang abgeschlossen ist, können Sie im Ereignishandler aufrufen BeginPeek oder BeginReceive erneut, um Benachrichtigungen zu empfangen.

BeginPeek gibt einen IAsyncResult Wert zurück, der den asynchronen Vorgang identifiziert, den die Methode gestartet hat. Sie können dies IAsyncResult während der gesamten Lebensdauer des Vorgangs verwenden, obwohl Sie sie in der Regel erst verwenden, wenn EndPeek(IAsyncResult) sie aufgerufen wird. Wenn Sie jedoch mehrere asynchrone Vorgänge starten, können Sie deren IAsyncResult Werte in einem Array platzieren und angeben, ob alle Vorgänge oder alle Vorgänge abgeschlossen werden sollen. In diesem Fall verwenden Sie die AsyncWaitHandle Eigenschaft der IAsyncResult zum Identifizieren des abgeschlossenen Vorgangs.

Das Statusobjekt ordnet Statusinformationen dem Vorgang zu. Wenn Sie z. B. mehrere Male aufrufen BeginPeek , um mehrere Vorgänge zu initiieren, können Sie jeden Vorgang über ein separates Zustandsobjekt identifizieren, das Sie definieren.

In der folgenden Tabelle wird gezeigt, ob diese Methode in verschiedenen Arbeitsgruppenmodi verfügbar ist.

Weitere Informationen

• PeekCompleted
• BeginReceive()
• Peek()
• Receive()
• AsyncCallback
• TimeSpan

public:
 IAsyncResult ^ BeginPeek(TimeSpan timeout, System::Object ^ stateObject);

public IAsyncResult BeginPeek(TimeSpan timeout, object stateObject);

member this.BeginPeek : TimeSpan * obj -> IAsyncResult

Public Function BeginPeek (timeout As TimeSpan, stateObject As Object) As IAsyncResult

Parameter

Gibt zurück

Dies IAsyncResult identifiziert die bereitgestellte asynchrone Anforderung.

Ausnahmen

Beispiele

Im folgenden Codebeispiel wird ein asynchroner Vorschauvorgang mithilfe des Warteschlangenpfads ".\myQueue" erstellt. Er erstellt einen Ereignishandler und MyPeekCompletedfügt ihn an den PeekCompleted Ereignishandlerdelegat an. BeginPeek wird mit einem Timeout von einer Minute aufgerufen. Jeder Aufruf verfügt über BeginPeek eine eindeutige ganzzahlige Zahl, die diesen bestimmten Vorgang identifiziert. Wenn ein PeekCompleted Ereignis ausgelöst oder das Timeout abgelaufen ist, wird die Nachricht( sofern vorhanden) abgerufen, und der Textkörper und der vorgangsspezifische ganzzahlige Bezeichner werden auf den Bildschirm geschrieben. BeginPeek Anschließend wird erneut aufgerufen, um einen neuen asynchronen Vorschauvorgang mit demselben Timeout und der zugeordneten Ganzzahl des gerade abgeschlossenen Vorgangs zu initiieren.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:

   // Represents a state object associated with each message.
   static int messageNumber = 0;

   // Provides an event handler for the PeekCompleted
   // event.
   //
   static void MyPeekCompleted( Object^ source, PeekCompletedEventArgs^ asyncResult )
   {
      try
      {
         // Connect to the queue.
         MessageQueue^ mq = dynamic_cast<MessageQueue^>(source);

         // End the asynchronous peek operation.
         Message^ m = mq->EndPeek( asyncResult->AsyncResult );

         // Display message information on the screen, 
         // including the message number (state object).
         Console::WriteLine( "Message: {0} {1}", asyncResult->AsyncResult->AsyncState, static_cast<String^>(m->Body) );

         // Restart the asynchronous peek operation, with the 
         // same time-out.
         mq->BeginPeek( TimeSpan(0,1,0), messageNumber++ );
      }
      catch ( MessageQueueException^ e ) 
      {
         if ( e->MessageQueueErrorCode == MessageQueueErrorCode::IOTimeout )
         {
            Console::WriteLine( e );
         }

         // Handle other sources of MessageQueueException.
      }

      // Handle other exceptions.
      return;
   }
};


// Provides an entry point into the application.
//         
// This example performs asynchronous peek 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 PeekCompleted event.
   myQueue->PeekCompleted += gcnew PeekCompletedEventHandler( MyNewQueue::MyPeekCompleted );

   // Begin the asynchronous peek operation with a timeout 
   // of one minute.
   myQueue->BeginPeek( TimeSpan(0,1,0), MyNewQueue::messageNumber++ );

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

using System;
using System.Messaging;

namespace MyProject
{
    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue3
    {
        // Represents a state object associated with each message.
        static int messageNumber = 0;

        //**************************************************
        // Provides an entry point into the application.
        //		
        // This example performs asynchronous peek 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 PeekCompleted event.
            myQueue.PeekCompleted += new
                PeekCompletedEventHandler(MyPeekCompleted);

            // Begin the asynchronous peek operation with a time-out
            // of one minute.
            myQueue.BeginPeek(new TimeSpan(0, 1, 0), messageNumber++);

            // Do other work on the current thread.

            return;
        }

        //**************************************************
        // Provides an event handler for the PeekCompleted
        // event.
        //**************************************************

        private static void MyPeekCompleted(Object source,
            PeekCompletedEventArgs asyncResult)
        {
            try
            {
                // Connect to the queue.
                MessageQueue mq = (MessageQueue)source;

                // End the asynchronous peek operation.
                Message m = mq.EndPeek(asyncResult.AsyncResult);

                // Display message information on the screen,
                // including the message number (state object).
                Console.WriteLine("Message: " +
                    (int)asyncResult.AsyncResult.AsyncState + " "
                    + (string)m.Body);

                // Restart the asynchronous peek operation, with the
                // same time-out.
                mq.BeginPeek(new TimeSpan(0, 1, 0), messageNumber++);
            }

            catch (MessageQueueException e)
            {
                if (e.MessageQueueErrorCode ==
                    MessageQueueErrorCode.IOTimeout)
                {
                    Console.WriteLine(e.ToString());
                }

                // Handle other sources of MessageQueueException.
            }

            // Handle other exceptions.

            return;
        }
    }
}

Imports System.Messaging


   
' Provides a container class for the example.

Public Class MyNewQueue

        ' Represents a state object associated with each message.
        Private Shared messageNumber As Integer = 0



        ' 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() _
                {GetType([String])})

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

            ' Begin the asynchronous peek operation with a time-out 
            ' of one minute.
            myQueue.BeginPeek(New TimeSpan(0, 1, 0), messageNumber)
            messageNumber += 1

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



        ' Provides an event handler for the PeekCompleted
        ' event.


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

            Try
                ' 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, 
                ' including(the) message number (state object).
                Console.WriteLine(("Message: " + _
                    CInt(asyncResult.AsyncResult.AsyncState) + _
                    " " + CStr(m.Body)))

                ' Restart the asynchronous peek operation, with the 
                ' same time-out.
                mq.BeginPeek(New TimeSpan(0, 1, 0), messageNumber)
                messageNumber += 1


            Catch e As MessageQueueException

                If e.MessageQueueErrorCode = _
                    MessageQueueErrorCode.IOTimeout Then

                    Console.WriteLine(e.ToString())

                    ' Handle other sources of MessageQueueException.

                End If

                ' Handle other exceptions.

            End Try

            Return

        End Sub

End Class

Hinweise

Bei asynchroner Verarbeitung wird BeginPeek das PeekCompleted Ereignis ausgelöst, wenn eine Nachricht in der Warteschlange verfügbar wird oder wenn das angegebene Zeitintervall abgelaufen ist.

PeekCompleted wird auch ausgelöst, wenn in der Warteschlange bereits eine Nachricht vorhanden ist.

Verwenden Sie diese Überladung, um Informationen mit dem Vorgang zu verknüpfen, der während der gesamten Lebensdauer des Vorgangs erhalten bleibt. Der Ereignishandler kann auf diese Informationen zugreifen, indem er sich die AsyncState Eigenschaft der IAsyncResult dem Vorgang zugeordneten Eigenschaft ansieht.

Erstellen Sie zum Verwenden BeginPeekeinen Ereignishandler, der die Ergebnisse des asynchronen Vorgangs verarbeitet, und ordnen Sie ihn dem Ereignisdelegat zu. BeginPeek initiiert einen asynchronen Vorschauvorgang; wird MessageQueue über das Auslösen des PeekCompleted Ereignisses benachrichtigt, wenn eine Nachricht in der Warteschlange eintrifft. Der MessageQueue Zugriff auf die Nachricht erfolgt dann durch Aufrufen EndPeek(IAsyncResult) oder Abrufen des Ergebnisses mithilfe der PeekCompletedEventArgs.

Die BeginPeek Methode gibt sofort zurück, aber der asynchrone Vorgang wird erst abgeschlossen, wenn der Ereignishandler aufgerufen wird.

Da BeginPeek asynchron ist, können Sie die Warteschlange aufrufen, ohne den aktuellen Ausführungsthread zu blockieren. Verwenden Sie die Peek Methode, um die Warteschlange synchron anzuzeigen.

Sobald ein asynchroner Vorgang abgeschlossen ist, können Sie im Ereignishandler aufrufen BeginPeek oder BeginReceive erneut, um Benachrichtigungen zu empfangen.

BeginPeek gibt einen IAsyncResult Wert zurück, der den asynchronen Vorgang identifiziert, den die Methode gestartet hat. Sie können dies IAsyncResult während der gesamten Lebensdauer des Vorgangs verwenden, obwohl Sie sie in der Regel erst verwenden, wenn EndPeek(IAsyncResult) sie aufgerufen wird. Wenn Sie jedoch mehrere asynchrone Vorgänge starten, können Sie deren IAsyncResult Werte in einem Array platzieren und angeben, ob alle Vorgänge oder alle Vorgänge abgeschlossen werden sollen. In diesem Fall verwenden Sie die AsyncWaitHandle Eigenschaft der IAsyncResult zum Identifizieren des abgeschlossenen Vorgangs.

Diese Überladung gibt ein Timeout und ein Zustandsobjekt an. Wenn das durch den timeout Parameter angegebene Intervall abläuft, löst diese Komponente das PeekCompleted Ereignis aus. Da keine Nachricht vorhanden ist, löst ein nachfolgenden Aufruf EndPeek(IAsyncResult) eine Ausnahme aus.

Das Statusobjekt ordnet Statusinformationen dem Vorgang zu. Wenn Sie z. B. mehrere Male aufrufen BeginPeek , um mehrere Vorgänge zu initiieren, können Sie jeden Vorgang über ein separates Zustandsobjekt identifizieren, das Sie definieren. Eine Abbildung dieses Szenarios finden Sie im Abschnitt "Beispiel".

Sie können auch das Statusobjekt verwenden, um Informationen über Prozessthreads hinweg zu übergeben. Wenn ein Thread gestartet wird, aber sich der Rückruf in einem asynchronen Szenario auf einem anderen Thread befindet, wird das Statusobjekt gemarstet und zusammen mit Informationen aus dem Ereignis übergeben.

Wenn CanRead dies der Fall ist false, wird das Abschlussereignis ausgelöst, aber beim Aufrufen EndPeek(IAsyncResult)wird eine Ausnahme ausgelöst.

In der folgenden Tabelle wird gezeigt, ob diese Methode in verschiedenen Arbeitsgruppenmodi verfügbar ist.

Weitere Informationen

• PeekCompleted
• BeginReceive()
• Peek()
• Receive()
• TimeSpan

public:
 IAsyncResult ^ BeginPeek(TimeSpan timeout, System::Messaging::Cursor ^ cursor, System::Messaging::PeekAction action, System::Object ^ state, AsyncCallback ^ callback);

public IAsyncResult BeginPeek(TimeSpan timeout, System.Messaging.Cursor cursor, System.Messaging.PeekAction action, object state, AsyncCallback callback);

member this.BeginPeek : TimeSpan * System.Messaging.Cursor * System.Messaging.PeekAction * obj * AsyncCallback -> IAsyncResult

Public Function BeginPeek (timeout As TimeSpan, cursor As Cursor, action As PeekAction, state As Object, callback As AsyncCallback) As IAsyncResult

Parameter

Gibt zurück

Dies IAsyncResult identifiziert die bereitgestellte asynchrone Anforderung.

Ausnahmen

Hinweise

Wenn Sie diese Überladung verwenden, wird der im Rückrufparameter angegebene Rückruf direkt aufgerufen, wenn eine Nachricht in der Warteschlange verfügbar wird oder wenn das angegebene Zeitintervall abgelaufen ist. Das PeekCompleted Ereignis wird nicht ausgelöst. Die anderen Überladungen, die BeginPeek von dieser Komponente abhängen, um das PeekCompleted Ereignis auszuheben.

PeekCompleted wird auch ausgelöst, wenn in der Warteschlange bereits eine Nachricht vorhanden ist.

Die BeginPeek Methode gibt sofort zurück, aber der asynchrone Vorgang wird erst abgeschlossen, wenn der Ereignishandler aufgerufen wird.

Da BeginPeek asynchron ist, können Sie die Warteschlange aufrufen, ohne den aktuellen Ausführungsthread zu blockieren. Verwenden Sie die Peek Methode, um die Warteschlange synchron anzuzeigen.

Sobald ein asynchroner Vorgang abgeschlossen ist, können Sie im Ereignishandler aufrufen BeginPeek oder BeginReceive erneut, um Benachrichtigungen zu empfangen.

BeginPeek gibt einen IAsyncResult Wert zurück, der den asynchronen Vorgang identifiziert, der von der Methode gestartet wurde. Sie können dies IAsyncResult während der gesamten Lebensdauer des Vorgangs verwenden, obwohl Sie sie in der Regel erst verwenden, wenn EndPeek(IAsyncResult) sie aufgerufen wird. Wenn Sie jedoch mehrere asynchrone Vorgänge starten, können Sie deren IAsyncResult Werte in einem Array platzieren und angeben, ob alle Vorgänge oder alle Vorgänge abgeschlossen werden sollen. Verwenden Sie in diesem Fall die AsyncWaitHandle Eigenschaft des IAsyncResult abgeschlossenen Vorgangs, um den abgeschlossenen Vorgang zu identifizieren.

Das Statusobjekt ordnet Statusinformationen dem Vorgang zu. Wenn Sie z. B. mehrere Male aufrufen BeginPeek , um mehrere Vorgänge zu initiieren, können Sie jeden Vorgang über ein separates Zustandsobjekt identifizieren, das Sie definieren.

In der folgenden Tabelle wird gezeigt, ob diese Methode in verschiedenen Arbeitsgruppenmodi verfügbar ist.

Weitere Informationen

• PeekCompleted
• BeginReceive()
• Peek()
• Receive()
• AsyncCallback
• TimeSpan

public:
 IAsyncResult ^ BeginPeek();

public IAsyncResult BeginPeek();

member this.BeginPeek : unit -> IAsyncResult

Public Function BeginPeek () As IAsyncResult

Gibt zurück

Dies IAsyncResult identifiziert die bereitgestellte asynchrone Anforderung.

Ausnahmen

Beispiele

Das folgende Codebeispiel erstellt einen Ereignishandler mit dem Namen MyPeekCompleted, fügt ihn an den PeekCompleted Ereignishandlerdelegat an und ruft auf BeginPeek , um einen asynchronen Vorschauvorgang in der Warteschlange zu initiieren, die sich im Pfad ".\myQueue" befindet. Wenn ein PeekCompleted Ereignis ausgelöst wird, zeigt das Beispiel die Nachricht an und schreibt den Textkörper auf den Bildschirm. Anschließend wird erneut aufgerufen BeginPeek , um einen neuen asynchronen Vorschauvorgang zu initiieren.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

// This example performs asynchronous peek operation
// processing.
//*************************************************
ref class MyNewQueue
{
public:

   // Provides an event handler for the PeekCompleted
   // event.
   static void MyPeekCompleted( Object^ source, PeekCompletedEventArgs^ asyncResult )
   {
      // Connect to the queue.
      MessageQueue^ mq = dynamic_cast<MessageQueue^>(source);

      // End the asynchronous peek operation.
      Message^ m = mq->EndPeek( asyncResult->AsyncResult );

      // Display message information on the screen.
      Console::WriteLine( "Message: {0}", static_cast<String^>(m->Body) );

      // Restart the asynchronous peek operation.
      mq->BeginPeek();
      return;
   }
};

// Provides an entry point into the application.
//         
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 PeekCompleted event.
   myQueue->PeekCompleted += gcnew PeekCompletedEventHandler( MyNewQueue::MyPeekCompleted );

   // Begin the asynchronous peek operation.
   myQueue->BeginPeek();

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

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 peek 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 PeekCompleted event.
            myQueue.PeekCompleted += new
                PeekCompletedEventHandler(MyPeekCompleted);

            // Begin the asynchronous peek operation.
            myQueue.BeginPeek();

            // Do other work on the current thread.

            return;
        }

        //**************************************************
        // Provides an event handler for the PeekCompleted
        // event.
        //**************************************************

        private static void MyPeekCompleted(Object source,
            PeekCompletedEventArgs asyncResult)
        {
            // Connect to the queue.
            MessageQueue mq = (MessageQueue)source;

            // End the asynchronous peek operation.
            Message m = mq.EndPeek(asyncResult.AsyncResult);

            // Display message information on the screen.
            Console.WriteLine("Message: " + (string)m.Body);

            // Restart the asynchronous peek operation.
            mq.BeginPeek();

            return;
        }
    }
}

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() _
                {GetType([String])})

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

            ' Begin the asynchronous peek operation.
            myQueue.BeginPeek()

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


        '**************************************************
        ' 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.
            mq.BeginPeek()

            Return

        End Sub

End Class

Hinweise

Bei asynchroner Verarbeitung wird BeginPeek das PeekCompleted Ereignis ausgelöst, wenn eine Nachricht in der Warteschlange verfügbar wird.

PeekCompleted wird auch ausgelöst, wenn in der Warteschlange bereits eine Nachricht vorhanden ist.

Erstellen Sie zum Verwenden BeginPeekeinen Ereignishandler, der die Ergebnisse des asynchronen Vorgangs verarbeitet, und ordnen Sie ihn dem Ereignisdelegat zu. BeginPeek initiiert einen asynchronen Vorschauvorgang; wird MessageQueue über das Auslösen des PeekCompleted Ereignisses benachrichtigt, wenn eine Nachricht in der Warteschlange eintrifft. Der MessageQueue Zugriff auf die Nachricht erfolgt dann durch Aufrufen EndPeek(IAsyncResult) oder Abrufen des Ergebnisses mithilfe der PeekCompletedEventArgs.

Die BeginPeek Methode gibt sofort zurück, aber der asynchrone Vorgang wird erst abgeschlossen, wenn der Ereignishandler aufgerufen wird.

Da BeginPeek asynchron ist, können Sie die Warteschlange aufrufen, ohne den aktuellen Ausführungsthread zu blockieren. Verwenden Sie die Peek Methode, um die Warteschlange synchron anzuzeigen.

Sobald ein asynchroner Vorgang abgeschlossen ist, können Sie im Ereignishandler aufrufen BeginPeek oder BeginReceive erneut, um Benachrichtigungen zu empfangen.

Der IAsyncResult Zurückgegebene BeginPeek gibt den asynchronen Vorgang an, den die Methode gestartet hat. Sie können dies IAsyncResult während der gesamten Lebensdauer des Vorgangs verwenden, obwohl Sie sie in der Regel erst verwenden, wenn EndPeek(IAsyncResult) sie aufgerufen wird. Wenn Sie jedoch mehrere asynchrone Vorgänge starten, können Sie deren IAsyncResult Werte in einem Array platzieren und angeben, ob alle Vorgänge oder alle Vorgänge abgeschlossen werden sollen. In diesem Fall verwenden Sie die AsyncWaitHandle Eigenschaft der IAsyncResult zum Identifizieren des abgeschlossenen Vorgangs.

Wenn CanRead dies der Fall ist false, wird das Abschlussereignis ausgelöst, aber beim Aufrufen EndPeek(IAsyncResult)wird eine Ausnahme ausgelöst.

In der folgenden Tabelle wird gezeigt, ob diese Methode in verschiedenen Arbeitsgruppenmodi verfügbar ist.

Weitere Informationen

• PeekCompleted
• BeginReceive()
• Peek()
• Receive()

public:
 IAsyncResult ^ BeginPeek(TimeSpan timeout);

public IAsyncResult BeginPeek(TimeSpan timeout);

member this.BeginPeek : TimeSpan -> IAsyncResult

Public Function BeginPeek (timeout As TimeSpan) As IAsyncResult

Parameter

Gibt zurück

Dies IAsyncResult identifiziert die bereitgestellte asynchrone Anforderung.

Ausnahmen

Beispiele

Im folgenden Codebeispiel wird ein asynchroner Vorschauvorgang mithilfe des Warteschlangenpfads ".\myQueue" erstellt. Er erstellt einen Ereignishandler und MyPeekCompletedfügt ihn an den PeekCompleted Ereignishandlerdelegat an. BeginPeek wird mit einem Timeout von einer Minute aufgerufen, um den asynchronen Vorschauvorgang zu initiieren. Wenn ein PeekCompleted Ereignis ausgelöst wird oder das Timeout abläuft, wird die Nachricht abgerufen, sofern vorhanden, und der Textkörper wird auf den Bildschirm geschrieben. BeginPeek Anschließend wird erneut aufgerufen, um einen neuen asynchronen Vorschauvorgang mit dem gleichen Timeout zu initiieren.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:
   static void MyPeekCompleted( Object^ source, PeekCompletedEventArgs^ asyncResult )
   {      try
      {
         // Connect to the queue.
         MessageQueue^ mq = dynamic_cast<MessageQueue^>(source);

         // End the asynchronous peek operation.
         Message^ m = mq->EndPeek( asyncResult->AsyncResult );

         // Display message information on the screen.
         Console::WriteLine( "Message: {0}", static_cast<String^>(m->Body) );

         // Restart the asynchronous peek operation, with the 
         // same time-out.
         mq->BeginPeek( TimeSpan(0,1,0) );
      }
      catch ( MessageQueueException^ e ) 
      {
         if ( e->MessageQueueErrorCode == MessageQueueErrorCode::IOTimeout )
         {
            Console::WriteLine( e );
         }

         // Handle other sources of MessageQueueException.
      }

      // Handle other exceptions.
      return;
   }
};

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 PeekCompleted event.
   myQueue->PeekCompleted += gcnew PeekCompletedEventHandler( MyNewQueue::MyPeekCompleted );

   // Begin the asynchronous peek operation with a timeout 
   // of one minute.
   myQueue->BeginPeek( TimeSpan(0,1,0) );

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

using System;
using System.Messaging;

namespace MyProject
{
    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue2
    {
        //**************************************************
        // Provides an entry point into the application.
        //		
        // This example performs asynchronous peek 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 PeekCompleted event.
            myQueue.PeekCompleted += new
                PeekCompletedEventHandler(MyPeekCompleted);

            // Begin the asynchronous peek operation with a time-out
            // of one minute.
            myQueue.BeginPeek(new TimeSpan(0, 1, 0));

            // Do other work on the current thread.

            return;
        }

        //**************************************************
        // Provides an event handler for the PeekCompleted
        // event.
        //**************************************************

        private static void MyPeekCompleted(Object source,
            PeekCompletedEventArgs asyncResult)
        {
            try
            {
                // Connect to the queue.
                MessageQueue mq = (MessageQueue)source;

                // End the asynchronous peek operation.
                Message m = mq.EndPeek(asyncResult.AsyncResult);

                // Display message information on the screen.
                Console.WriteLine("Message: " + (string)m.Body);

                // Restart the asynchronous peek operation, with the
                // same time-out.
                mq.BeginPeek(new TimeSpan(0, 1, 0));
            }

            catch (MessageQueueException e)
            {
                if (e.MessageQueueErrorCode ==
                    MessageQueueErrorCode.IOTimeout)
                {
                    Console.WriteLine(e.ToString());
                }

                // Handle other sources of MessageQueueException.
            }

            // Handle other exceptions.

            return;
        }
    }
}

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() _
                    {GetType([String])})

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

            ' Begin the asynchronous peek operation with a time-out 
            ' of one minute.
            myQueue.BeginPeek(New TimeSpan(0, 1, 0))

            ' Do other work on the current thread.
            Return

        End Sub



        ' Provides an event handler for the PeekCompleted
        ' event.


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

            Try
                ' 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, with the 
                ' same time-out.
                mq.BeginPeek(New TimeSpan(0, 1, 0))

            Catch e As MessageQueueException

                If e.MessageQueueErrorCode = _
                    MessageQueueErrorCode.IOTimeout Then

                    Console.WriteLine(e.ToString())

                    ' Handle other sources of MessageQueueException.
                End If

                ' Handle other exceptions.

            End Try

            Return

        End Sub

End Class

Hinweise

Bei asynchroner Verarbeitung wird BeginPeek das PeekCompleted Ereignis ausgelöst, wenn eine Nachricht in der Warteschlange verfügbar wird oder wenn das angegebene Zeitintervall abgelaufen ist.

PeekCompleted wird auch ausgelöst, wenn in der Warteschlange bereits eine Nachricht vorhanden ist.

Erstellen Sie zum Verwenden BeginPeekeinen Ereignishandler, der die Ergebnisse des asynchronen Vorgangs verarbeitet, und ordnen Sie ihn dem Ereignisdelegat zu. BeginPeek initiiert einen asynchronen Vorschauvorgang; wird MessageQueue über das Auslösen des PeekCompleted Ereignisses benachrichtigt, wenn eine Nachricht in der Warteschlange eintrifft. Der MessageQueue Zugriff auf die Nachricht erfolgt dann durch Aufrufen EndPeek(IAsyncResult) oder Abrufen des Ergebnisses mithilfe der PeekCompletedEventArgs.

Die BeginPeek Methode gibt sofort zurück, aber der asynchrone Vorgang wird erst abgeschlossen, wenn der Ereignishandler aufgerufen wird.

Da BeginPeek asynchron ist, können Sie die Warteschlange aufrufen, ohne den aktuellen Ausführungsthread zu blockieren. Verwenden Sie die Peek Methode, um die Warteschlange synchron anzuzeigen.

Sobald ein asynchroner Vorgang abgeschlossen ist, können Sie im Ereignishandler aufrufen BeginPeek oder BeginReceive erneut, um Benachrichtigungen zu empfangen.

Der IAsyncResult Zurückgegebene BeginPeek gibt den asynchronen Vorgang an, den die Methode gestartet hat. Sie können dies IAsyncResult während der gesamten Lebensdauer des Vorgangs verwenden, obwohl Sie sie in der Regel erst verwenden, wenn EndPeek(IAsyncResult) sie aufgerufen wird. Wenn Sie jedoch mehrere asynchrone Vorgänge starten, können Sie deren IAsyncResult Werte in einem Array platzieren und angeben, ob alle Vorgänge oder alle Vorgänge abgeschlossen werden sollen. In diesem Fall verwenden Sie die AsyncWaitHandle Eigenschaft der IAsyncResult zum Identifizieren des abgeschlossenen Vorgangs.

Diese Überladung gibt einen Timeout an. Wenn das durch den timeout Parameter angegebene Intervall abläuft, löst diese Komponente das PeekCompleted Ereignis aus. Da keine Nachricht vorhanden ist, löst ein nachfolgenden Aufruf EndPeek(IAsyncResult) eine Ausnahme aus.

Wenn CanRead dies der Fall ist false, wird das Abschlussereignis ausgelöst, aber beim Aufrufen EndPeek(IAsyncResult)wird eine Ausnahme ausgelöst.

In der folgenden Tabelle wird gezeigt, ob diese Methode in verschiedenen Arbeitsgruppenmodi verfügbar ist.

Weitere Informationen

• PeekCompleted
• BeginReceive()
• Peek()
• Receive()
• TimeSpan