PeekCompletedEventArgs クラス
PeekCompleted イベントのデータを提供します。非同期のピーク操作がイベント ハンドラを呼び出すと、そのクラスのインスタンスがハンドラに渡されます。
この型のすべてのメンバの一覧については、PeekCompletedEventArgs メンバ を参照してください。
System.Object
System.EventArgs
System.Messaging.PeekCompletedEventArgs
Public Class PeekCompletedEventArgs
Inherits EventArgs
[C#]
public class PeekCompletedEventArgs : EventArgs
[C++]
public __gc class PeekCompletedEventArgs : public EventArgs
[JScript]
public class PeekCompletedEventArgs extends EventArgs
スレッドセーフ
この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。
解説
イベント通知を使ってキューからメッセージを非同期にピークする (削除せずに読み取る) ときは、そのメッセージ処理を行うメソッドを作成する必要があります。その場合は、非同期処理を開始するために BeginPeek を呼び出す必要があります。メッセージがピークされるときに、 PeekCompleted イベントを通じてアプリケーションに通知が送信されます。イベント ハンドラを呼び出すイベント デリゲートに、 PeekCompletedEventArgs のインスタンスが渡されます。 PeekCompleted イベントに関連付けられているデータは、デリゲートの AsyncResult パラメータに格納されます。
メモ イベントの完了を通知させる方法には、イベント通知とコールバックの 2 種類があります。 PeekCompletedEventArgs はイベント通知でだけ使われます。コールバックとイベント通知の比較については、MSDN ライブラリの「イベントによる通知とコールバックによる通知」を参照してください。
PeekCompletedEventArgs は、 Message メンバを通じて非同期のピーク操作の最終処理を開始したメッセージへのアクセスを実現します。これはメッセージへの代替アクセスであり、 MessageQueue.EndPeek を呼び出す場合とほとんど動作は同じです。
使用例
[Visual Basic, C#, C++] PeekCompleted イベントのイベント ハンドラを作成し、 PeekCompletedEventHandler を使ってそのハンドラをイベント デリゲートに関連付ける例を次に示します。このイベント ハンドラ MyPeekCompleted
は、メッセージをピークし、そのラベルを画面に書き込みます。
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++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。
必要条件
名前空間: 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 内)
参照
PeekCompletedEventArgs メンバ | System.Messaging 名前空間 | MessageQueue | PeekCompletedEventHandler | PeekCompleted | BeginPeek | EndPeek | Message