MiniportCheckForHang (Compact 2013)

  • Article

3/26/2014

This optional function reports the state of the network adapter or monitors the responsiveness of an underlying device driver.

Syntax

BOOLEAN MiniportCheckForHang(
  NDIS_HANDLE MiniportAdapterContext
);

Parameters

  • MiniportAdapterContext
    [in] Specifies the handle to a miniport-allocated context area in which the driver maintains per-network adapter state, set up by MiniportInitialize

Return Value

MiniportCheckForHang returns TRUE if the driver determines that its network adapter is not operating or if an intermediate driver determines that the underlying device driver is unresponsive.

Remarks

In network adapter drivers, MiniportCheckForHang does nothing more than check the internal state of the network adapter and return TRUE if it detects that the network adapter is not operating correctly.

In intermediate drivers, MiniportCheckForHang can periodically check the state of the driver's virtual network adapter to determine whether the underlying device driver has stopped responding.

By default, the NDIS library calls MiniportCheckForHang approximately every two seconds.

If MiniportCheckForHang returns TRUE, NDIS then calls the driver's MiniportReset function.

If a network adapter driver has no MiniportCheckForHang function and NDIS judges the driver unresponsive as, for example, when NDIS holds many pending sends and requests queued to the miniport for a time-out interval, NDIS calls the driver's MiniportReset function. The NDIS library's default time-out interval for queued sends and requests is around four seconds. However, a network adapter driver's MiniportInitialize function can extend the NDIS time-out interval by calling NdisMSetAttributesEx from MiniportInitialize to avoid unnecessary resets.

The MiniportInitialize function of an intermediate driver should disable NDIS's time-out interval with NdisMSetAttributesEx because such a driver can neither control nor estimate a reasonable completion interval for the underlying device driver.

MiniportCheckForHang can be pre-empted by an interrupt.

Requirements

Header

externs.h

See Also

Reference

NDIS 5.x Legacy Functions
MiniportInitialize
MiniportReset
NdisMSetAttributesEx
NDIS 5.x Legacy Reference