Edit

Share via

NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS structure (ndischimney.h)

  • Article

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

The NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS structure specifies a protocol driver's generic chimney offload entry points. Generic chimney offload entry points apply to all chimney offload types. Currently, TCP chimney offload is the only defined chimney offload type.

Syntax

typedef struct _NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS {
  NDIS_OBJECT_HEADER                  Header;
  ULONG                               Flags;
  INITIATE_OFFLOAD_COMPLETE_HANDLER   InitiateOffloadCompleteHandler;
  TERMINATE_OFFLOAD_COMPLETE_HANDLER  TerminateOffloadCompleteHandler;
  UPDATE_OFFLOAD_COMPLETE_HANDLER     UpdateOffloadCompleteHandler;
  INVALIDATE_OFFLOAD_COMPLETE_HANDLER InvalidateOffloadCompleteHandler;
  QUERY_OFFLOAD_COMPLETE_HANDLER      QueryOffloadCompleteHandler;
  INDICATE_OFFLOAD_EVENT_HANDLER      IndicateOffloadEventHandler;
} NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS, *PNDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS;

Members

Header

The header of the NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS structure. The header is formatted as an NDIS_OBJECT_HEADER structure. The NDIS_OBJECT_HEADER structure contains the revision number of the NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS structure and the size of the NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS structure, including the header, in bytes. The Type member of the header is not significant.

Flags

Reserved for system use.

InitiateOffloadCompleteHandler

Specifies the entry point of the driver's ProtocolInitiateOffloadComplete function.

TerminateOffloadCompleteHandler

The entry point of the driver's ProtocolTerminateOffloadComplete function.

UpdateOffloadCompleteHandler

The entry point of the driver's ProtocolUpdateOffloadComplete function.

InvalidateOffloadCompleteHandler

The entry point of the driver's ProtocolInvalidateOffloadComplete function.

QueryOffloadCompleteHandler

The entry point of the driver's ProtocolQueryOffloadComplete function.

IndicateOffloadEventHandler

The entry point of the driver's ProtocolIndicateOffloadEvent function.

Remarks

To register its generic chimney offload entry points, a protocol or intermediate driver calls the NdisSetOptionalHandlers function in the context of the ProtocolSetOptions function. To the NdisSetOptionalHandlers function, the protocol or intermediate driver passes a pointer to the NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS structure.

Requirements

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

See also

NDIS_OBJECT_HEADER

NdisSetOptionalHandlers

ProtocolIndicateOffloadEvent ProtocolInitiateOffloadComplete ProtocolInvalidateOffloadComplete ProtocolQueryOffloadComplete

ProtocolSetOptions

ProtocolTerminateOffloadComplete ProtocolUpdateOffloadComplete