MiniportCheckForHang
MiniportCheckForHang is an optional function that reports the state of the network adapter or monitors the responsiveness of an underlying device driver.
BOOLEAN
MiniportCheckForHang(
IN NDIS_HANDLE MiniportAdapterContext );
Parameters
- MiniportAdapterContext
Specifies the handle to a miniport-allocated context area in which the driver maintains per-network adapter state, set up by MiniportInitialize.
Return Values
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.
Comments
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 appears to be hung.
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 NDIS's 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
| Runs on | Versions | Defined in | Include | Link to |
|---|---|---|---|---|
| Windows CE OS | 2.0 and later | Ndis.h | Ndislib.lib |
Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
MiniportInitialize, MiniportReset, NdisMSetAttributesEX
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.