Edit

NEIGHBOR_OFFLOAD_STATE_CACHED structure (ndischimney.h)

  • Article

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

The NEIGHBOR_OFFLOAD_STATE_CACHED structure contains the cached variables of a neighbor state object.

Syntax

typedef struct _NEIGHBOR_OFFLOAD_STATE_CACHED {
  OFFLOAD_STATE_HEADER Header;
  UCHAR                DlDestinationAddress[32];
  ULONG                HostReachabilityDelta;
} NEIGHBOR_OFFLOAD_STATE_CACHED, *PNEIGHBOR_OFFLOAD_STATE_CACHED;

Members

Header

An OFFLOAD_STATE_HEADER structure. NDIS sets the Length member of Header to the size, in bytes, of the NEIGHBOR_OFFLOAD_STATE_CACHED structure. The RecognizedOptions member of Header is reserved.

DlDestinationAddress[32]

Specifies the media access control (MAC) address of the next hop (neighbor).

HostReachabilityDelta

The host stack's current time minus HostReachabilityDelta is the last time that the host stack confirmed neighbor reachability (see forward reachability in RFC 2461). For information about how the offload target uses this variable, see NdisMOffloadEventIndicate. HostReachabilityDelta is measured in units of clock ticks.

Remarks

Cached variables are owned and maintained by the host stack. An offload target must not change the value of a cached variable unless requested to do so by the host stack. If the value of a cached variable changes, the host stack requests an update of the variable, which causes NDIS to call the offload target's MiniportUpdateOffload function. When the host stack terminates the offload of one or more state objects by causing NDIS to call the offload target's MiniportTerminateOffload function, the offload target does not return the value of offloaded constant variables to the host stack.

When passed to an offload target, a NEIGHBOR_OFFLOAD_STATE_CACHED structure is associated with an NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure, which contains a header that is formatted as an NDIS_OBJECT_HEADER structure. The Revision member of the NDIS_OBJECT_HEADER structure, in this case, specifies the revision number of the NEIGHBOR_OFFLOAD_STATE_CACHED structure.

Requirements

Requirement Value
Header ndischimney.h (include Ndischimney.h)

See also

MiniportTerminateOffload

MiniportUpdateOffload

NDIS_OBJECT_HEADER

NEIGHBOR_OFFLOAD_STATE_CONST

NEIGHBOR_OFFLOAD_STATE_DELEGATED

OFFLOAD_STATE_HEADER