INDICATE_OFFLOAD_EVENT_HANDLER callback function (ndischimney.h)

Article
02/22/2024

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

NDIS calls a protocol driver's or intermediate driver's ProtocolIndicateOffloadEvent function to post an indication that was initiated by an underlying driver's or offload target's call to the NdisMOffloadEventIndicate function.

Syntax

INDICATE_OFFLOAD_EVENT_HANDLER IndicateOffloadEventHandler;

void IndicateOffloadEventHandler(
  [in] IN NDIS_HANDLE ProtocolBindingContext,
  [in] IN PNDIS_PROTOCOL_OFFLOAD_BLOCK_LIST OffloadBlockList,
  [in] IN ULONG IndicationCode
)
{...}

Parameters

[in] ProtocolBindingContext

A handle to a context area that was 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] OffloadBlockList

A pointer to an NDIS_PROTOCOL_OFFLOAD_BLOCK_LIST structure. This structure identifies the offloaded state object on which the indication is being made. Note that there is only one NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure. There is not a linked list of such structures.

The underlying offload target supplies a valid OffloadBlockList pointer when making a NeighborReachabilityQuery indication. In this case, the offload target supplies a NEIGHBOR_OFFLOAD_STATE_CONST structure, a NEIGHBOR_OFFLOAD_STATE_CACHED structure, and a NEIGHBOR_OFFLOAD_STATE_DELEGATED structure (in that order) immediately following the NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure referenced by the OffloadBlockList pointer.

[in] IndicationCode

The event being indicated as one of the following INDICATE_OFFLOAD_EVENT values:

NeighborReachabilityQuery

Indicates that a neighbor cache entry (NCE) has become stale. For more information about NCEs, see RFC 2461.

NeighborReachabilityInDoubt

Reserved.

Return value

None

Remarks

The implementation of this function for intermediate drivers is to be determined.

Requirements

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