ReceiveCompletedEventArgs クラス

[アーティクル]
03/28/2008

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

この型のすべてのメンバの一覧については、ReceiveCompletedEventArgs メンバを参照してください。

System.Object
System.EventArgs
System.Messaging.ReceiveCompletedEventArgs

Public Class ReceiveCompletedEventArgs
   Inherits EventArgs
[C#]
public class ReceiveCompletedEventArgs : EventArgs
[C++]
public __gc class ReceiveCompletedEventArgs : public EventArgs
[JScript]
public class ReceiveCompletedEventArgs extends EventArgs

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

イベント通知を使ってキューからメッセージを非同期に受信するときは、そのメッセージ処理を行うメソッドを作成する必要があります。その場合は、非同期処理を開始するために BeginReceive を呼び出す必要があります。メッセージが受信されるときに、 ReceiveCompleted イベントを通じてアプリケーションに通知が送信されます。イベントハンドラを呼び出すイベントデリゲートに、 ReceiveCompletedEventArgs のインスタンスが渡されます。 ReceiveCompleted イベントに関連付けられているデータは、デリゲートの AsyncResult パラメータに格納されます。

メモイベントの完了を通知させる方法には、イベント通知とコールバックの 2 種類があります。 ReceiveCompletedEventArgs はイベント通知でだけ使われます。コールバックとイベント通知の比較については、MSDN ライブラリの「イベントによる通知とコールバックによる通知」を参照してください。

ReceiveCompletedEventArgs は、 Message メンバを通じて非同期の受信操作の最終処理を開始したメッセージへのアクセスを実現します。これはメッセージへの代替アクセスであり、 MessageQueue.EndReceive を呼び出す場合とほとんど動作は同じです。

使用例

[Visual Basic, C#, C++] ReceiveCompleted イベントのイベントハンドラを作成し、 ReceiveCompletedEventHandler を使ってそのハンドラをイベントデリゲートに関連付ける例を次に示します。このイベントハンドラ (MyReceiveCompleted) は、キューからメッセージを受信してその本文を画面に書き込みます。

 
Imports System
Imports 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 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
End Namespace 'MyProject

[C#] 
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 receive 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 ReceiveCompleted event.
            myQueue.ReceiveCompleted += new 
                ReceiveCompletedEventHandler(MyReceiveCompleted);
            
            // Begin the asynchronous receive operation.
            myQueue.BeginReceive();
            
            // Do other work on the current thread.

            return;
        }


        //**************************************************
        // Provides an event handler for the ReceiveCompleted
        // event.
        //**************************************************
        
        private static void MyReceiveCompleted(Object source, 
            ReceiveCompletedEventArgs asyncResult)
        {
            // Connect to the queue.
            MessageQueue mq = (MessageQueue)source;

            // End the asynchronous Receive operation.
            Message m = mq.EndReceive(asyncResult.AsyncResult);

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

            // Restart the asynchronous Receive operation.
            mq.BeginReceive();
            
            return; 
        }
    }
}

[C++] 
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

__gc class MyNewQueue 
{
    //*************************************************
    // Provides an event handler for the ReceiveCompleted
    // event.
    //*************************************************
public:
    static void MyReceiveCompleted(Object* source, 
        ReceiveCompletedEventArgs* asyncResult) 
    {
        // Connect to the queue.
        MessageQueue* mq = dynamic_cast<MessageQueue*>(source);

        // End the asynchronous Receive operation.
        Message* m = mq->EndReceive(asyncResult->AsyncResult);

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

        // Restart the asynchronous Receive operation.
        mq->BeginReceive();

        return; 
    }
};

//*************************************************
// Provides an entry point into the application.
//         
// This example performs asynchronous receive operation
// processing.
//*************************************************
int main() 
{
    // Create an instance of MessageQueue. Set its formatter.
    MessageQueue* myQueue = new MessageQueue(S".\\myQueue");

    Type* p __gc[] = new Type* __gc[1];
    p[0] = __typeof(String);
    myQueue->Formatter = new XmlMessageFormatter( p );

    // Add an event handler for the ReceiveCompleted event.
    myQueue->ReceiveCompleted += new ReceiveCompletedEventHandler(0, MyNewQueue::MyReceiveCompleted);

    // Begin the asynchronous receive operation.
    myQueue->BeginReceive();

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

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.Messaging

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System.Messaging (System.Messaging.dll 内)

参照

次の方法で共有

ReceiveCompletedEventArgs クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース