TCP_OFFLOAD_RECV_COMPLETE_HANDLER callback function (ndischimney.h)

Article
10/21/2021

[The TCP chimney offload feature is deprecated and should not be used.]

NDIS calls a protocol or intermediate driver's ProtocolTcpOffloadReceiveComplete function to complete a receive operation that the driver previously initiated by calling the NdisOffloadTcpReceive function.

Syntax

TCP_OFFLOAD_RECV_COMPLETE_HANDLER TcpOffloadRecvCompleteHandler;

void TcpOffloadRecvCompleteHandler(
  [in] IN NDIS_HANDLE ProtocolBindingContext,
  [in] IN PNET_BUFFER_LIST NetBufferList
)
{...}

Parameters

[in] ProtocolBindingContext

A handle to a context area allocated by the protocol driver. The driver maintains the per binding context information in this context area. The driver supplied this handle to NDIS when the driver called the NdisOpenAdapterEx function.

[in] NetBufferList

A pointer to a NET_BUFFER_LIST structure. This structure can be stand-alone or the first structure in a linked list of NET_BUFFER_LIST structures. The driver supplied this pointer as an input parameter in a previous call to the NdisOffloadTcpReceive function.

Return value

None

Remarks

In response to an underlying driver's or offload target's call to the NdisOffloadTcpReceiveComplete function, NDIS calls the overlying protocol driver's or intermediate driver's ProtocolTcpOffloadReceiveComplete function.

To propagate the completion of the I/O operation to the overlying driver, the intermediate driver itself calls the NdisOffloadTcpReceiveComplete function, passing in the following:

A ProtocolBindingContext, which is a handle that uniquely identifies the intermediate driver.
The PNET_BUFFER_LIST pointer that NDIS passed to the intermediate driver's ProtocolTcpOffloadReceiveComplete function.

In response, NDIS calls the overlying driver's ProtocolTcpOffloadReceiveComplete function, passing a ProtocolBindingContext handle and the PNET_BUFFER_LIST pointer supplied by the intermediate driver to the NdisOffloadTcpReceiveComplete function.

Requirements

Requirement	Value
Target Platform	Windows
Header	ndischimney.h (include Ndischimney.h)