NdisMOffloadEventIndicate function (ndischimney.h)

Article
10/21/2021

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

An offload target calls the NdisMOffloadEventIndicate function to indicate various events to the host stack.

Syntax

void NdisMOffloadEventIndicate(
  [in] IN NDIS_HANDLE                       NdisMiniportHandle,
  [in] IN PNDIS_MINIPORT_OFFLOAD_BLOCK_LIST OffloadBlockList,
  [in] IN ULONG                             IndicationCode
);

Parameters

[in] NdisMiniportHandle

The handle that the offload target obtained in a previous call to NdisMRegisterMiniportDriver.

[in] OffloadBlockList

A pointer to an NDIS_MINIPORT_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 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.

An offload target must initialize the following members of an NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure that it passes to the NdisMOffloadEventIndicate function:

All members of the NDIS_OBJECT_HEADER structure, including Type, Revision, and Size . The offload target must initialize Type to NeighborOffloadState.
The NextBlock pointer to a non-NULL value if there is a next block; otherwise, to NULL.
The DependentBlockList pointer to NULL.
The Status member to NDIS_STATUS_SUCCESS.

The offload target does not have to initialize any other members of the NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure.

For all indications other than the NeighborReachabilityQuery indication, the offload target supplies an OffloadBlockList pointer that is NULL.

[in] IndicationCode

The event being indicated is specified 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 host stack uses the NeighborReachabilityQuery indication to detect neighbor unreachability for IPv4 and IPv6. For a detailed description of this indication, see Making a NeighborReachabilityQuery Indication.

Requirements

Requirement	Value
Target Platform	Universal
Header	ndischimney.h (include Ndischimney.h)
IRQL	DISPATCH_LEVEL