NDIS_TCP_OFFLOAD_RECEIVE_INDICATE コールバック関数 (ndischimney.h)

[アーティクル]
08/07/2023

[TCP チムニーオフロード機能は非推奨であり、使用しないでください。]

オフロードターゲットは NdisTcpOffloadReceiveHandler 関数を呼び出して、受信したネットワークデータがクライアントアプリケーションで使用可能であることを示します。

構文

NDIS_TCP_OFFLOAD_RECEIVE_INDICATE NdisTcpOffloadReceiveIndicate;

NDIS_STATUS NdisTcpOffloadReceiveIndicate(
  [in]  IN NDIS_HANDLE NdisOffloadHandle,
  [in]  IN PNET_BUFFER_LIST NetBufferList,
  [in]  IN NDIS_STATUS Status,
  [out] OUT PULONG BytesConsumed
)
{...}

パラメーター

[in] NdisOffloadHandle

指示が行われているオフロードされた TCP 接続を識別するハンドル。接続がオフロードされたとき、このハンドルはの NdisOffloadHandle メンバーで指定されました。 NDIS_MINIPORT_OFFLOAD_BLOCK_LIST 接続状態に関連付けられた構造体です。

[in] NetBufferList

NET_BUFFER_LIST構造体へのポインター。各 NET_BUFFER_LIST 構造体は、 NET_BUFFER 構造体の一覧を記述します。リスト 内の各NET_BUFFER 構造体は、メモリ記述子リスト (MDL) のチェーンにマップされます。 MDL には、受信したデータが含まれています。 MDP はロックされ、常駐したままですが、システムメモリにはマップされません。

NetBufferList によって指定されるNET_BUFFER_LIST構造体はスタンドアロン構造体である必要があり、NET_BUFFER_LIST構造体のリンクされたリストの最初の構造体にすることはできません。オフロードターゲットは、オフロード受信インジケーター内の同じ NET_BUFFER に必要な数の MDL をチェーンすることで、この制限を回避できます。

[in] Status

オフロードターゲットは、次の状態値を指定する必要があります。

NDIS_STATUS_SUCCESS

これは、ホストスタックがこれらの構造体をに返すまで、NET_BUFFER_LIST構造体と関連する構造体の所有権を保持できることを示します。オフロードターゲットの MiniportTcpOffloadReceiveReturn 関数。

[out] BytesConsumed

クライアントアプリケーションによって使用されたバイト数を受け取る ULONG 型の変数へのポインター。

戻り値

NdisTcpOffloadReceiveHandler 関数は、次のいずれかの値を返すことができます。

リターンコード	説明
NDIS_STATUS_SUCCESS	クライアントアプリケーションは、指定されたすべての受信データを使用しました。
NDIS_STATUS_OFFLOAD_DATA_NOT_ACCEPTED	クライアントアプリケーションは、指定されたすべての受信データを拒否しました。
NDIS_STATUS_OFFLOAD_DATA_PARTIALLY_ACCEPTED	クライアントアプリケーションは、指定された受信データのサブセットを使用しました。クライアントアプリケーションによって使用されたデータの量 (バイト単位) は、 BytesConsumed パラメーターで指定された変数で返されます。

注釈

受信バッファーはにポストされます。オフロードターゲットの MiniportTcpOffloadReceive 関数。接続に対して事前にポストされた受信要求 (クライアントアプリケーションによって提供されるバッファー) が使用可能な場合、オフロードターゲットはを呼び出して受信データを転送する必要があります。 NdisTcpOffloadReceiveComplete 関数。詳細については、「配信アルゴリズム」を参照してください。

すべての受信要求は、オフロードターゲットによって完了する必要があります (0 バイトの受信要求であっても)。

オフロードターゲットが受信データを示し、データが拒否された後、オフロードターゲットは、ホストスタックが受信要求を投稿するまで、そのデータを再度示すことはできません。

通常の受信要求
ホストスタックが通常の受信要求を投稿する場合、オフロードターゲットは、受信通知を行う前に、これらの要求を完了する必要があります。詳細については、「配信アルゴリズム」を参照してください。
0 バイトの受信要求
ホストスタックは、0 バイトの受信要求をポストして、オフロードターゲットによる受信通知を有効にすることができます。 0 バイトの受信要求は、 DataLength メンバーの値が 0 である要求です (詳細については、「 NET_BUFFER 構造体」を参照してください)。 0 バイトの受信要求では、バッファーに格納されたデータは使用されません。

初期化中に、オフロードターゲットは 2 つのバッファープールを割り当てる必要があります。それぞれに、NET_BUFFER_LIST構造体とNET_BUFFER構造体が含まれます。オフロードターゲットは、を呼び出すときに TCP チムニーを介して受信指示を行うのに 1 つのプールを使用します。 NdisTcpOffloadReceiveHandler 関数。オフロードターゲットは、を呼び出すときに、nonoffload NDIS インターフェイスを介して受信指示を行う他のプールを使用します。 NdisMIndicateReceiveNetBufferLists 関数。

割り当てられた各NET_BUFFER_LIST構造体には、関連付けられているNET_BUFFER構造体が 1 つだけ必要です。割り当てるこのような構造体の数は、ドライバーライターにかかっています。このような構造体の割り当てについて詳しくは、「ミニポートドライバーバッファー管理」をご覧ください。

遅延受信確認を行っていない場合、オフロードターゲットは、オフロードターゲットにデータを格納できる内部バッファーがある場合に、受信したデータをすぐに確認する必要があります。オフロードターゲットは、 NdisTcpOffloadReceiveHandler 関数を呼び出す前、実行中、または呼び出した後に、受信したデータを確認できます。

オフロードターゲットは、NdisTcpOffloadReceiveHandler 関数を呼び出すときに常にNDIS_STATUS_SUCCESSの Status 値を提供します。これは、ホストスタックがこれらの構造体をオフロードターゲットに返すまで、NET_BUFFER_LIST構造体と関連する構造体の所有権を保持できることを示します。

ホストスタックがNDIS_STATUS_SUCCESSを返し、クライアントアプリケーションが受信データを受け入れて使用したことを示す場合、ホストスタックは NET_BUFFER_LIST 構造体をに返します。オフロードターゲットの MiniportTcpOffloadReceiveReturn 関数。ホストスタックは、 BytesConsumed パラメーターで指定された変数を、オフロードターゲットによって示されたバイト数に設定します。
ホストスタックがNDIS_STATUS_NOT_ACCEPTEDを返し、クライアントアプリケーションが受信データを拒否したことを示す場合、オフロードターゲットは NdisTcpOffloadReceiveHandler 関数の戻り時に、指定されたNET_BUFFER_LIST構造体の所有権を再開します。オフロードターゲットは、クライアントアプリケーションが接続で受信バッファーをポストすることを想定して、受信データをバッファーする必要があります。クライアントアプリケーションが受信バッファーをポストした後、オフロードターゲットは、バッファーされた受信データをポストされたバッファーにコピーし、を呼び出してポストされたバッファーを完了します。 NdisTcpOffloadReceiveComplete 関数。詳細については、「配信アルゴリズム」を参照してください。ホストスタックは、 BytesConsumed パラメーターで指定された変数を 0 に設定します。
クライアントアプリケーションが受信データのサブセットを使用したことを示すNDIS_STATUS_OFFLOAD_DATA_PARTIALLY_ACCEPTEDを返す場合、 NdisTcpOffloadReceiveHandler 関数が返されたときに、オフロードターゲットは示されたNET_BUFFER_LIST構造体の所有権を再開します。ホストスタックは、 BytesConsumed パラメーターで指定された変数を、クライアントアプリケーションによって使用されたデータの量 (バイト単位) を指定する 0 以外の値に設定します。オフロードターゲットは、クライアントアプリケーションが接続で受信バッファーをポストすることを想定して、残りの受信データをバッファーする必要があります。

NdisTcpOffloadReceiveHandler 関数を呼び出すときに、オフロードターゲットはNDIS_STATUS_RESOURCESの Status 値を提供しません。

TCP_OFFLOAD_STATE_CACHED構造体の RcvIndicationSize メンバーでは、ホストスタックは、 NdisTcpOffloadReceiveHandler 関数の 1 回の呼び出しでオフロードターゲットが指定する必要がある最適なデータバイト数を指定できます。詳細については、「指定された受信表示サイズの使用」を参照してください。