MessageQueue.EndPeek(IAsyncResult) Метод

Определение

Завершает указанную асинхронную операцию считывания.Completes the specified asynchronous peek operation.

public:
 System::Messaging::Message ^ EndPeek(IAsyncResult ^ asyncResult);
public System.Messaging.Message EndPeek (IAsyncResult asyncResult);
member this.EndPeek : IAsyncResult -> System.Messaging.Message
Public Function EndPeek (asyncResult As IAsyncResult) As Message

Параметры

asyncResult
IAsyncResult

Объект IAsyncResult, определяющий асинхронную операцию считывания, которая завершается и из которой извлекается конечный результат.The IAsyncResult that identifies the asynchronous peek operation to finish and from which to retrieve an end result.

Возвращаемое значение

Message

Класс Message, связанный с завершенной асинхронной операцией.The Message associated with the completed asynchronous operation.

Исключения

Параметр asyncResult имеет значение null.The asyncResult parameter is null.

Для параметра asyncResult используется неправильный синтаксис.The syntax of the asyncResult parameter is not valid.

При обращении к методу службы очереди сообщений возникла ошибка.An error occurred when accessing a Message Queuing method.

Примеры

В следующем примере кода создается обработчик событий с именем MyPeekCompleted , который прикрепляет его к PeekCompleted делегату обработчика событий и вызывается BeginPeek для инициации асинхронной операции просмотра в очереди, расположенной по пути ".\микуеуе".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". При PeekCompleted возникновении события пример считывает сообщение и записывает его текст на экран.When a PeekCompleted event is raised, the example peeks the message and writes its body to the screen. Затем в примере вызывается BeginPeek еще раз, чтобы инициировать новую асинхронную операцию просмотра.The example then calls BeginPeek again to initiate a new asynchronous peek operation.

#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

Комментарии

При PeekCompleted возникновении события EndPeek(IAsyncResult) завершает операцию, инициированную BeginPeek вызовом.When the PeekCompleted event is raised, EndPeek(IAsyncResult) completes the operation that was initiated by the BeginPeek call. Для этого EndPeek(IAsyncResult) просматривает сообщение.To do so, EndPeek(IAsyncResult) peeks the message.

BeginPeek может указывать время ожидания, которое вызывает PeekCompleted событие, если время ожидания возникает до появления сообщения в очереди.BeginPeek can specify a time-out, which causes the PeekCompleted event to be raised if the time-out occurs before a message appears in the queue. Если время ожидания происходит без сообщения, поступающего в очередь, последующий вызов EndPeek(IAsyncResult) вызывает исключение.When a time-out occurs without a message arriving in the queue, a subsequent call to EndPeek(IAsyncResult) throws an exception.

EndPeek(IAsyncResult) используется для чтения сообщения, которое привело PeekCompleted к возникновению события.EndPeek(IAsyncResult) is used to read the message that caused the PeekCompleted event to be raised.

Если вы хотите продолжить асинхронное считывание сообщений, можно снова вызвать метод BeginPeek после вызова EndPeek(IAsyncResult) .If you want to continue to asynchronously peek messages, you can again call BeginPeek after calling EndPeek(IAsyncResult).

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.The following table shows whether this method is available in various Workgroup modes.

Режим рабочей группыWorkgroup mode ДоступноAvailable
Локальный компьютерLocal computer ДаYes
Локальный компьютер и прямое имя форматаLocal computer and direct format name ДаYes
Удаленный компьютерRemote computer НетNo
Удаленный компьютер и прямое имя форматаRemote computer and direct format name ДаYes

Применяется к

См. также раздел