LPFN_RIONOTIFY

RIONotify 関数は、Winsock 登録済み I/O 拡張機能で使用する I/O 完了キューの通知動作に用いるメソッドを登録します。

エラーが発生しない場合、RIONotify 関数は ERROR_SUCCESS を返します。それ以外の場合、関数は失敗しており、特定のエラーコードが返されます。

RIONotify 関数は、Winsock 登録済み I/O 拡張機能によるネットワークデータの送受信に関する通知動作に用いるメソッドを登録します。

RIONotify 関数は、要求が完了し、RIODequeueCompletion 関数の呼び出しを待っていることをアプリケーションが知るための仕組みです。RIONotify 関数は、I/O 完了キューが空ではなく、結果の完了が格納されている場合の通知動作に用いるメソッドを設定します。

完了キューの通知動作は、RIO_CQ の作成時に設定されます。RIO_CQ の作成時には、RIO_NOTIFICATION_COMPLETION 構造体が RIOCreateCompletionQueue 関数に渡されます。

イベントを使用する完了キューでは、RIO_NOTIFICATION_COMPLETION 構造体の Type メンバーに RIO_EVENT_COMPLETION を設定します。Event.EventHandle メンバーには、WSACreateEvent 関数または CreateEvent 関数で作成したイベントのハンドルを格納します。RIONotify の完了を受け取るには、アプリケーションは WSAWaitForMultipleEvents または同様の待機ルーチンを使用して、指定したイベントハンドルを待機する必要があります。イベントをリセットして再利用する予定がある場合、アプリケーションは Event.NotifyReset メンバーに 0 以外の値を設定することでオーバーヘッドを削減できます。これにより、通知が発生した時点で RIONotify 関数がイベントを自動的にリセットします。その結果、RIONotify 関数の呼び出しと呼び出しの間に WSAResetEvent 関数を呼び出してイベントをリセットする必要がなくなります。

イベント完了を使用して RIONotify 関数を呼び出したときに、指定した完了キューが既に空でない場合、イベントは同期的または非同期的に設定されます。いずれの場合も、イベントが設定される前に追加のエントリが完了キューに入る必要はありません。RIO_MSG_DONT_NOTIFY フラグが設定されていない要求の完了が完了キューに格納されるまで、その完了キューは RIONotify 関数にとっては空とみなされ、イベントは設定されません。完了済みの要求は、いずれの場合でも RIODequeueCompletion 関数を使用して取得できます。イベントが設定されると、アプリケーションは通常、RIODequeueCompletion 関数を呼び出して、完了した送信要求および受信要求をデキューします。

I/O 完了ポートを使用する完了キューでは、RIO_NOTIFICATION_COMPLETION 構造体の Type メンバーに RIO_IOCP_COMPLETION を設定します。Iocp.IocpHandle メンバーには、CreateIoCompletionPort 関数で作成した I/O 完了ポートのハンドルを格納します。RIONotify の完了を受け取るには、アプリケーションは GetQueuedCompletionStatus 関数または GetQueuedCompletionStatusEx 関数を呼び出す必要があります。アプリケーションは、その完了キュー専用の OVERLAPPED オブジェクトを用意する必要があります。また、Iocp.CompletionKey メンバーを使用して、その完了キューに対する RIONotify 要求を、他の完了キューの RIONotify 完了を含むその他の I/O 完了と区別することもできます。

スレッドプールを使用するアプリケーションでは、スレッドプールの待機オブジェクトを使用して、スレッドプール経由で RIONotify の完了を受け取ることができます。その場合、SetThreadpoolWait 関数の呼び出しは、RIONotify の呼び出しの直後に行う必要があります。SetThreadpoolWait 関数を RIONotify より前に呼び出し、かつアプリケーションがイベントオブジェクトのクリアを RIONotify に依存している場合、待機オブジェクトのコールバックが意図せず実行されることがあります。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされます。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされます。