MessageQueue.EndReceive(IAsyncResult) メソッド

リファレンス

定義

名前空間:: System.Messaging

アセンブリ:: System.Messaging.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

指定した非同期の受信操作を完了します。

public:
 System::Messaging::Message ^ EndReceive(IAsyncResult ^ asyncResult);

public System.Messaging.Message EndReceive (IAsyncResult asyncResult);

member this.EndReceive : IAsyncResult -> System.Messaging.Message

Public Function EndReceive (asyncResult As IAsyncResult) As Message

パラメーター

asyncResult: IAsyncResult

完了する非同期の受信操作を識別する IAsyncResult。ここから最終結果が取得されます。

戻り値

Message

完了した非同期操作に関連付けられた Message。

例外

ArgumentNullException

asyncResult パラメーターが null です。

ArgumentException

asyncResult パラメーターの構文が無効です。

MessageQueueException

メッセージキューのメソッドにアクセスしたときにエラーが発生しました。

例

次のコード例では、非同期要求をチェーンします。 "myQueue" という名前のローカルコンピューターにキューがあることを前提としています。関数は Main 、ルーチンによって処理される非同期操作を MyReceiveCompleted 開始します。 MyReceiveCompleted は現在のメッセージを処理し、新しい非同期受信操作を開始します。

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

using namespace System;
using namespace System::Messaging;
using namespace System::Threading;

ref class MyNewQueue
{
public:

   // Define static class members.
   static ManualResetEvent^ signal = gcnew ManualResetEvent( false );
   static int count = 0;

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

         // End the asynchronous receive operation.
         mq->EndReceive( asyncResult->AsyncResult );
         count += 1;
         if ( count == 10 )
         {
            signal->Set();
         }

         // Restart the asynchronous receive operation.
         mq->BeginReceive();
      }
      catch ( MessageQueueException^ ) 
      {
         // Handle sources of MessageQueueException.
      }

      // Handle other exceptions.
      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 = 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 ReceiveCompleted event.
   myQueue->ReceiveCompleted += gcnew ReceiveCompletedEventHandler( MyNewQueue::MyReceiveCompleted );

   // Begin the asynchronous receive operation.
   myQueue->BeginReceive();
   MyNewQueue::signal->WaitOne();

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

using System;
using System.Messaging;
using System.Threading;

namespace MyProject
{
    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue
    {
        // Define static class members.
        static ManualResetEvent signal = new ManualResetEvent(false);
        static int count = 0;

        //**************************************************
        // 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();

            signal.WaitOne();
            
            // Do other work on the current thread.

            return;
        }

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

                // End the asynchronous receive operation.
                Message m = mq.EndReceive(asyncResult.AsyncResult);
                
                count += 1;
                if (count == 10)
                {
                    signal.Set();
                }

                // Restart the asynchronous receive operation.
                mq.BeginReceive();
            }
            catch(MessageQueueException)
            {
                // Handle sources of MessageQueueException.
            }
            
            // Handle other exceptions.
            
            return;
        }
    }
}

Imports System.Messaging
Imports System.Threading




' Provides a container class for the example.

Public Class MyNewQueue

        ' Define static class members.
        Private Shared signal As New ManualResetEvent(False)
        Private Shared count As Integer = 0



        ' 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()

            signal.WaitOne()

            ' Do other work on the current thread.

            Return

        End Sub



        ' Provides an event handler for the ReceiveCompleted
        ' event.


        Private Shared Sub MyReceiveCompleted(ByVal [source] As _
            [Object], ByVal asyncResult As ReceiveCompletedEventArgs)

            Try
                ' Connect to the queue.
                Dim mq As MessageQueue = CType([source], MessageQueue)

                ' End the asynchronous receive operation.
                Dim m As Message = _
                    mq.EndReceive(asyncResult.AsyncResult)

                count += 1
                If count = 10 Then
                    signal.Set()
                End If

                ' Restart the asynchronous receive operation.
                mq.BeginReceive()

            Catch
                ' Handle sources of MessageQueueException.

                ' Handle other exceptions.

            End Try

            Return

        End Sub

End Class

注釈

イベントが ReceiveCompleted 発生すると、 EndReceive(IAsyncResult) 呼び出しによって開始された操作が BeginReceive 完了します。これを行うには、 EndReceive(IAsyncResult) メッセージを受信します。

BeginReceive はタイムアウトを指定できます。これにより、メッセージが ReceiveCompleted キューに表示される前にタイムアウトが発生した場合にイベントが発生します。キューにメッセージが到着せずにタイムアウトが発生すると、後続のを EndReceive(IAsyncResult) 呼び出すと例外がスローされます。

EndReceive(IAsyncResult) は、イベントが発生した原因となった ReceiveCompleted メッセージの読み取り (キューからの削除) に使用されます。

メッセージを非同期的に受信し続ける場合は、を呼び出した後にもう一度を呼び出BeginReceive EndReceive(IAsyncResult)すことができます。

次の表は、このメソッドがさまざまなワークグループモードで使用できるかどうかを示しています。

ワークグループモード	利用可能
ローカルコンピューター	はい
ローカルコンピューターと直接の形式名	はい
リモートコンピューター	いいえ
リモートコンピューターと直接形式の名前	はい

適用対象

MessageQueue.EndReceive(IAsyncResult) メソッド

定義

パラメーター

戻り値

例外

例

注釈

適用対象

こちらもご覧ください

フィードバック

その他のリソース