NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS structure (ndischimney.h)

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

The NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS structure specifies a protocol or intermediate driver's TCP chimney offload-specific entry points.

Syntax

typedef struct _NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS {
  NDIS_OBJECT_HEADER                      Header;
  ULONG                                   Flags;
  NDIS_CHIMNEY_OFFLOAD_TYPE               OffloadType;
  TCP_OFFLOAD_SEND_COMPLETE_HANDLER       TcpOffloadSendCompleteHandler;
  TCP_OFFLOAD_RECV_COMPLETE_HANDLER       TcpOffloadReceiveCompleteHandler;
  TCP_OFFLOAD_DISCONNECT_COMPLETE_HANDLER TcpOffloadDisconnectCompleteHandler;
  TCP_OFFLOAD_FORWARD_COMPLETE_HANDLER    TcpOffloadForwardCompleteHandler;
  TCP_OFFLOAD_EVENT_HANDLER               TcpOffloadEventHandler;
  TCP_OFFLOAD_RECEIVE_INDICATE_HANDLER    TcpOffloadReceiveIndicateHandler;
} NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS, *PNDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS;

Members

Header

The header of the NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_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_TCP_CHARACTERISTICS structure and the size of the NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS structure, including the header, in bytes. The Type member of the header is not significant.

Flags

Reserved for system use.

OffloadType

The chimney offload type. The only allowable value is NdisTcpChimneyOffload, which specifies a TCP chimney.

TcpOffloadSendCompleteHandler

The entry point of the driver's ProtocolTcpOffloadSendComplete function.

TcpOffloadReceiveCompleteHandler

The entry point of the driver's ProtocolTcpOffloadReceiveComplete function.

TcpOffloadDisconnectCompleteHandler

The entry point of the driver's ProtocolTcpOffloadDisconnectComplete function.

TcpOffloadForwardCompleteHandler

The entry point of the driver's ProtocolTcpOffloadForwardComplete function.

TcpOffloadEventHandler

The entry point of the driver's ProtocolTcpOffloadEvent function.

TcpOffloadReceiveIndicateHandler

The entry point of the driver's ProtocolTcpOffloadReceiveIndicate function.

Remarks

To register its TCP 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_TCP_CHARACTERISTICS structure.

Requirements

See also

NDIS_OBJECT_HEADER

NdisSetOptionalHandlers

ProtocolSetOptions

ProtocolTcpOffloadEvent