PeekCompletedEventArgs クラス

定義

名前空間:

System.Messaging

アセンブリ:

System.Messaging.dll

PeekCompleted イベントのデータを提供します。 非同期のピーク操作がイベント ハンドラーを呼び出すと、そのクラスのインスタンスがハンドラーに渡されます。

public ref class PeekCompletedEventArgs : EventArgs

public class PeekCompletedEventArgs : EventArgs

type PeekCompletedEventArgs = class
    inherit EventArgs

Public Class PeekCompletedEventArgs
Inherits EventArgs

継承

Object

EventArgs

PeekCompletedEventArgs

例

次のコード例では、 イベントのイベント ハンドラーを PeekCompleted 作成し、 を使用 PeekCompletedEventHandlerしてイベント デリゲートに関連付けます。 イベント ハンドラー は、 MyPeekCompletedメッセージをピークし、そのラベルを画面に書き込みます。

#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

注釈

イベント通知を使用してキューからメッセージを非同期的にピーク (削除せずに読み取り) する場合は、メッセージ処理を処理するメソッドを作成する必要があります。 非同期処理を開始するには、コードで を呼び出す BeginPeek 必要があります。 メッセージがピークされると、 イベントを通じてアプリケーションに通知されます PeekCompleted 。 の PeekCompletedEventArgs インスタンスは、イベント ハンドラーを呼び出すイベント デリゲートに渡されます。 イベントに PeekCompleted 関連付けられているデータは、デリゲート AsyncResult の パラメーターに含まれています。

イベント完了の通知を提供するには、イベント通知とコールバックの 2 つの方法があります。 PeekCompletedEventArgs は、イベント通知でのみ使用されます。 コールバックとイベント通知の比較については、MSDN の「イベントとコールバック」を参照してください。

PeekCompletedEventArgs は、 メンバーを介して非同期ピーク操作の終了を開始したメッセージへのアクセスを Message 提供します。 これはメッセージへの代替アクセスであり、 の呼び出し MessageQueue.EndPeekとほぼ同じように動作します。

プロパティ

AsyncResult	要求された非同期操作の結果を取得または設定します。
Message	非同期のピーク操作に関連付けられているメッセージを取得します。

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• MessageQueue
• PeekCompletedEventHandler
• PeekCompleted
• BeginPeek()
• EndPeek(IAsyncResult)
• Message