LPFN_RIORECEIVE コールバック関数 (mswsock.h)
RIOReceive 関数は、Winsock 登録済み I/O 拡張機能で使用するために、接続された登録済み I/O TCP ソケットまたはバインドされた登録済み I/O UDP ソケット上のネットワーク データを受信します。
構文
LPFN_RIORECEIVE LpfnRioreceive;
BOOL LpfnRioreceive(
RIO_RQ SocketQueue,
PRIO_BUF pData,
ULONG DataBufferCount,
DWORD Flags,
PVOID RequestContext
)
{...}
パラメーター
SocketQueue
接続された登録済み I/O TCP ソケットまたはバインドされた登録済み I/O UDP ソケットを識別する記述子。
pData
データを受信する登録済みバッファーの部分の説明。
アプリケーションが UDP データグラムでデータ ペイロードを受信する必要がない場合、バインドされた登録済み I/O UDP ソケットの場合、このパラメーターは NULL になることがあります。
DataBufferCount
pData パラメーターが指すバッファーでデータを受信するかどうかを示すデータ バッファーカウント パラメーター。
pData が NULL の場合、このパラメーターは 0 に設定する必要があります。 それ以外の場合は、このパラメーターを 1 に設定する必要があります。
Flags
RIOReceive 関数の動作を変更するフラグのセット。
Flags パラメーターには、ヘッダー ファイルでMswsockdef.h定義されている次のオプションの組み合わせを含めることができます。
RIO_MSG_COMMIT_ONLY
RIO_MSG_DEFER フラグで追加された以前の要求はコミットされます。
RIO_MSG_COMMIT_ONLY フラグが設定されている場合、他のフラグを指定することはできません。 RIO_MSG_COMMIT_ONLY フラグが設定されている場合、pData 引数と RequestContext 引数は NULL、DataBufferCount 引数は 0 である必要があります。
通常、このフラグは、 RIO_MSG_DEFER フラグが設定された状態で多数の要求が発行された後に使用されます。 これにより、 RIO_MSG_DEFER フラグを使用して、 RIO_MSG_DEFER フラグなしで最後の要求を行う必要がなくなります。これにより、最後の要求が他の要求よりもはるかに遅く完了します。
RIOReceive 関数の他の呼び出しとは異なり、RIO_MSG_COMMIT_ONLY フラグが設定されている場合、RIOReceive 関数の呼び出しをシリアル化する必要はありません。 1 つのRIO_RQの場合、RIOReceive 関数は、別のスレッドで RIOReceive 関数を呼び出している間に、1 つのスレッドで RIO_MSG_COMMIT_ONLYを使用して呼び出すことができます。
RIO_MSG_DONT_NOTIFY
要求の完了が完了キューに挿入された場合、要求は RIONotify 関数をトリガーしないでください。
RIO_MSG_DEFER
要求をすぐに実行する必要はありません。 これにより要求が要求キューに挿入されますが、要求の実行がトリガーされる場合とトリガーされない場合があります。
RIO_MSG_DEFER フラグを設定せずに SocketQueue パラメーターで渡RIO_RQに対して受信要求が行われるまで、データ受信が遅延する可能性があります。 要求キュー内のすべての受信に対して実行をトリガーするには、RIO_MSG_DEFER フラグを設定せずに RIOReceive または RIOReceiveEx 関数を呼び出します。
注意
受信要求は、RIO_MSG_DEFERが設定されているかどうかに関係なく、SocketQueue パラメーターで渡されたRIO_RQの未処理の I/O 容量に対して課金されます。
RIO_MSG_WAITALL
RIOReceive 関数は、次のいずれかのイベントが発生するまで完了しません。
- pData パラメーターで呼び出し元によって提供されるバッファー セグメントが完全にいっぱいです。
- 接続は閉じられました。
- 要求が取り消されたか、エラーが発生しました。
このフラグは、UDP ソケットではサポートされていません。
RequestContext
この受信操作に関連付ける要求コンテキスト。
戻り値
エラーが発生しない場合、 RIOReceive 関数は TRUE を返します。 この場合、受信操作は正常に開始され、完了は既にキューに登録されているか、操作が正常に開始され、完了は後でキューに入れられます。
FALSE の値は、関数が失敗し、操作が正常に開始されず、完了通知がキューに登録されないことを示します。 WSAGetLastError 関数を呼び出すことで、特定のエラー コードを取得できます。
| リターン コード | 説明 |
|---|---|
| WSAEFAULT | 呼び出しでポインター引数を使用しようとしたときに、システムにより、無効なポインター アドレスが検出されました。 このエラーは、操作がキューに登録または呼び出される前にパラメーターで渡された RIO_BUF 構造体のいずれかに対してバッファー ID が登録解除されたか、バッファーが解放された場合に返されます。 |
| WSAEINVAL | 無効なパラメーターが関数に渡されました。 SocketQueue パラメーターが無効な場合、Flags パラメーターに受信操作で無効な値が含まれている場合、または完了キューの整合性が損なわれた場合、このエラーが返されます。 このエラーは、パラメーターに関する他の問題でも返すことができます。 |
| WSAENOBUFS | 十分なメモリを割り当てませんでした。 SocketQueue パラメーターに関連付けられている I/O 完了キューがいっぱいであるか、受信エントリが 0 個の I/O 完了キューが作成された場合、このエラーが返されます。 |
| WSA_OPERATION_ABORTED | 受信操作が保留中の間に操作が取り消されました。 ソケットがローカルまたはリモートで閉じている場合、または WSAIoctl の SIO_FLUSH コマンドがこのソケットで実行された場合、このエラーが返されます。 |
注釈
アプリケーションは RIOReceive 関数を使用して、1 つの登録済みバッファー内に完全に含まれる任意のバッファーにネットワーク データを受信できます。 pData パラメーターが指すRIO_BUF構造体の Offset メンバーと Length メンバーは、バッファー内のネットワーク データを受信する場所を決定します。
RIOReceive 関数が呼び出されると、RIO_BUF 構造体のBufferId メンバーのRIO_BUFFERIDを含む pData パラメーターに渡されるバッファーは、受信操作の間有効なままである必要があります。
競合状態を回避するために、要求が完了する前に、受信要求に関連付けられているバッファーを読み取ったり書き込んだりしないでください。 これには、送信要求のソースとしてバッファーを使用するか、別の受信要求の送信先を使用することも含まれます。 受信要求に関連付けられていない登録済みバッファーの一部は、この制限には含まれません。
Flags パラメーターを使用すると、関連するソケットに指定されたオプションを超えて、RIOReceive 関数の呼び出しの動作に影響を与えることができます。 この関数の動作は、 SocketQueue パラメーターに関連付けられているソケットに設定されたソケット オプションと Flags パラメーターで指定された値の組み合わせによって決まります。
注意
RIOReceive 関数への関数ポインターは、実行時に、SIO_GET_MULTIPLE_EXTENSION_FUNCTION_POINTERオペコードを指定して WSAIoctl 関数を呼び出すことによって取得する必要があります。 WSAIoctl 関数に渡される入力バッファーには、Winsock に登録されている I/O 拡張関数を識別する値を持つグローバル一意識別子 (GUID) WSAID_MULTIPLE_RIOが含まれている必要があります。 成功すると、 WSAIoctl 関数によって返される出力には、Winsock に登録されている I/O 拡張関数へのポインターを含む RIO_EXTENSION_FUNCTION_TABLE 構造体へのポインターが含まれます。 SIO_GET_MULTIPLE_EXTENSION_FUNCTION_POINTER IOCTL は、Ws2def.h ヘッダー ファイルで定義されています。 WSAID_MULTIPLE_RIO GUID は、Mswsock.h ヘッダー ファイルで定義されています。
Windows Phone 8: この関数は、Windows Phone 8 以降のWindows Phone ストア アプリでサポートされています。
Windows 8.1とWindows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストア アプリでサポートされています。
要件
| 要件 | 値 |
|---|---|
| Header | mswsock.h |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示