MessageQueue.EndPeek メソッド
指定した非同期のピーク操作を完了します。
Public Function EndPeek( _
ByVal asyncResult As IAsyncResult _) As Message
[C#]
public Message EndPeek(IAsyncResultasyncResult);
[C++]
public: Message* EndPeek(IAsyncResult* asyncResult);
[JScript]
public function EndPeek(
asyncResult : IAsyncResult) : Message;
パラメータ
- asyncResult
完了する非同期のピーク操作を識別する IAsyncResult 。ここから終了結果が取得されます。
戻り値
完了する非同期操作に関連付けられた Message 。
例外
例外の種類 | 条件 |
---|---|
ArgumentNullException | asyncResult パラメータが null 参照 (Visual Basic では Nothing) です。 |
ArgumentException | asyncResult パラメータの構文が無効です。 |
MessageQueueException | メッセージ キューの API にアクセスしたときにエラーが発生しました。 |
解説
PeekCompleted イベントが発生したときに、 EndPeek は BeginPeek 呼び出しで開始された操作を完了します。操作を完了するために、 EndPeek はメッセージをピークします。
BeginPeek はタイムアウトを指定できます。タイムアウトを指定すると、キューにメッセージが到達する前にタイムアウトが発生した場合に、 PeekCompleted イベントが発生します。この場合、 asyncResult パラメータの IsCompleted プロパティは true に設定されますが、メッセージは操作に関連付けられません。メッセージがキューに到達する前にタイムアウトが発生すると、後続の EndPeek 呼び出しは例外をスローします。
PeekCompleted イベントを発生させたメッセージを読み取るには、 EndPeek を使用します。
メッセージを非同期にピークし続けるには、 EndPeek を呼び出した後でもう一度 BeginPeek を呼び出します。
このメソッドが各種のワークグループ モードで使用できるかどうかを次の表に示します。
ワークグループ モード | 使用可否 |
---|---|
ローカル コンピュータ | はい |
ローカル コンピュータ + 直接書式名 | はい |
リモート コンピュータ | いいえ |
リモート コンピュータ + 直接書式名 | はい |
使用例
[Visual Basic, C#, C++] イベント ハンドラ MyPeekCompleted
を作成し、 PeekCompleted イベント ハンドラ デリゲートに結び付け、 BeginPeek を呼び出して非同期のピーク操作を実行する例を次に示します。ピーク操作の対象になるキューは ".\myQueue" パスにあります。 PeekCompleted イベントが発生すると、この例はメッセージをピークし、本文を画面に書き込みます。次に、 BeginPeek をもう一度呼び出して、新しい非同期のピーク操作を実行します。
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 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 'Main
'**************************************************
' 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 'MyPeekCompleted
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 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;
}
}
}
[C++]
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
// This example performs asynchronous peek operation
// processing.
//*************************************************
__gc class MyNewQueue
{
// Provides an event handler for the PeekCompleted
// event.
public:
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(S"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 = 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 PeekCompleted event.
myQueue->PeekCompleted += new PeekCompletedEventHandler(0, MyNewQueue::MyPeekCompleted);
// Begin the asynchronous peek operation.
myQueue->BeginPeek();
// 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 クラス | MessageQueue メンバ | System.Messaging 名前空間 | BeginPeek | PeekCompleted | EndReceive