MessageQueue.ReceiveCompleted イベント

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

メッセージがキューから削除されると発生します。このイベントは、非同期操作 BeginReceive によって発生します。

Public Event ReceiveCompleted As ReceiveCompletedEventHandler
[C#]
public event ReceiveCompletedEventHandler ReceiveCompleted;
[C++]
public: __event ReceiveCompletedEventHandler* ReceiveCompleted;

[JScript] JScript では、このクラスで定義されているイベントを処理できます。ただし、独自に定義することはできません。

イベントデータ

イベントハンドラが、このイベントに関連するデータを含む、ReceiveCompletedEventArgs 型の引数を受け取りました。次の ReceiveCompletedEventArgs プロパティには、このイベントの固有の情報が記載されます。

プロパティ	説明
AsyncResult	要求された非同期操作の結果を取得または設定します。
Message	非同期の受信操作に関連付けられているメッセージを取得します。

解説

非同期処理では、 BeginReceive を使用して、キューのメッセージが利用可能になったときに ReceiveCompleted イベントを発生させます。

ReceiveCompleted イベントが発生したときに、 EndReceive を使用して BeginReceive 呼び出しで実行した操作を完了し、メッセージをピークします。

ReceiveCompletedEventHandler デリゲートを作成する場合は、イベントを処理するメソッドを識別してください。イベントをイベントハンドラに関連付けるには、デリゲートのインスタンスをイベントに追加します。デリゲートを削除しない限り、そのイベントが発生すると常にイベントハンドラが呼び出されます。イベントハンドラデリゲートの詳細については、「イベントとデリゲート」を参照してください。

使用例

[Visual Basic, C#, C++] イベントハンドラ MyReceiveCompleted を作成し、 ReceiveCompleted イベントハンドラデリゲートに結び付け、 BeginReceive を呼び出して非同期の受信操作を実行する例を次に示します。受信操作の対象になるキューは ".\myQueue" パスにあります。 ReceiveCompleted イベントが発生すると、この例はメッセージを受信し、本文を画面に書き込みます。次に、 BeginReceive をもう一度呼び出して、新しい非同期の受信操作を実行します。

 
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++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

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

.NET Framework セキュリティ:

直前の呼び出し元の完全信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細の参照先 : 部分信頼コードからのライブラリの使用

参照

次の方法で共有

MessageQueue.ReceiveCompleted イベント

イベントデータ

解説

使用例

必要条件

参照

その他のリソース

次の方法で共有

MessageQueue.ReceiveCompleted イベント

イベント データ

解説

使用例

必要条件

参照

その他のリソース

イベントデータ