This documentation is archived and is not being maintained.

NdisMSetPeriodicTimer function

Note   NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

NdisMSetPeriodicTimer sets a timer to fire periodically, thereby running an associated MiniportTimer function repeatedly at fixed intervals.

Syntax


VOID NdisMSetPeriodicTimer(
  _In_ PNDIS_MINIPORT_TIMER Timer,
  _In_ UINT                 MillisecondsPeriod
);

Parameters

Timer [in]

Pointer to caller-supplied resident storage for a timer object previously initialized with NdisMInitializeTimer.

MillisecondsPeriod [in]

Specifies the interval, in milliseconds, to time out before calling the MiniportTimer function unless the timer is canceled or this interval is reset.

Return value

None

Remarks

NdisMSetPeriodicTimer causes the driver-supplied MiniportTimer function, which was associated with the timer object when MiniportInitialize called NdisMInitializeTimer, to be run repeatedly whenever the given MillisecondsPeriod expires. At the initial call to NdisMSetPeriodicTimer, the timer object is queued until the MillisecondsPeriod expires, when the MiniportTimer function is run and the timer object is automatically requeued for the next interval.

By contrast, NdisMSetTimer causes the driver-supplied function associated with a particular timer object to run only once after the given MillisecondsToDelay expires. That is, execution of the function associated with the Timer passed to NdisMSetTimer is episodic, rather than periodic.

As a general rule, a miniport driver should allocate and initialize two timer objects if it calls both NdisMSetPeriodicTimer and NdisMSetTimer. Such a driver is likely to have two MiniportTimer functions with different functionality, each associated with a particular timer object when it is initialized with NdisMInitializeTimer. For example, a MiniportTimer function that runs periodically might poll device state at regular intervals, while another MiniportTimer function might retry a particular run-time operation only if it times out on the NIC.

If a miniport driver calls NdisMSetPeriodicTimer, NdisMCancelTimer, or NdisMSetTimer with the same Timer pointer originally passed to NdisMSetPeriodicTimer, the current call cancels its preceding call to NdisMSetPeriodicTimer, possibly resetting the MillisecondsPeriod specified originally. Any call to NdisMSet..Timer resets the given timer to expire at the interval specified in the most recent call and causes the associated MiniportTimer function to run when the most recently specified interval has expired.

Timer resolution on the host varies. Consequently, calling NdisMSetPeriodicTimer with very small periods does not necessarily cause the execution of the MiniportTimer function exactly when the specified interval expires. The minimum practicable interval to specify on Windows 2000 and later platforms is ten milliseconds.

Requirements

Target platform

Universal

Version

Not supported for NDIS 6.0 drivers in Windows Vista. Use NdisSetTimerObjectinstead. Supported for NDIS 5.1 drivers in Windows Vista and Windows XP.

Header

Ndis.h (include Ndis.h)

Library

Ndis.lib

IRQL

<= DISPATCH_LEVEL

See also

MiniportInitialize
MiniportTimer
NdisMCancelTimer
NdisMInitializeTimer
NdisMSetTimer

 

 

Send comments about this topic to Microsoft

Show: