#include <Os/WatchdogTimer.hpp>

Public Types
enum	WatchdogStatus { WATCHDOG_OK , WATCHDOG_INIT_ERROR , WATCHDOG_START_ERROR , WATCHDOG_CANCEL_ERROR }

typedef void(*	WatchdogCb) (void *)

Public Member Functions
	WatchdogTimer ()

virtual	~WatchdogTimer ()

WatchdogStatus	startTicks (I32 delayInTicks, WatchdogCb p_callback, void *parameter)

WatchdogStatus	startMs (I32 delayInMs, WatchdogCb p_callback, void *parameter)

WatchdogStatus	restart ()
	restart timer with previous value

WatchdogStatus	cancel ()
	cancel timer

void	expire ()
	Invoke the callback function with m_parameter.

Detailed Description

Definition at line 7 of file WatchdogTimer.hpp.

Member Typedef Documentation

◆ WatchdogCb

typedef void(* Os::WatchdogTimer::WatchdogCb) (void *)

Definition at line 17 of file WatchdogTimer.hpp.

Member Enumeration Documentation

◆ WatchdogStatus

enum Os::WatchdogTimer::WatchdogStatus

Enumerator
WATCHDOG_OK	Call was successful.
WATCHDOG_INIT_ERROR	Timer initialization failed.
WATCHDOG_START_ERROR	Timer startup failed.
WATCHDOG_CANCEL_ERROR	Timer cancellation failed.

Definition at line 10 of file WatchdogTimer.hpp.

Constructor & Destructor Documentation

◆ WatchdogTimer()

Os::WatchdogTimer::WatchdogTimer ( )

Definition at line 6 of file WatchdogTimer.cpp.

◆ ~WatchdogTimer()

Os::WatchdogTimer::~WatchdogTimer ( )

virtual

Definition at line 11 of file WatchdogTimer.cpp.

Member Function Documentation

◆ cancel()

WatchdogTimer::WatchdogStatus Os::WatchdogTimer::cancel ( )

cancel timer

Definition at line 26 of file WatchdogTimer.cpp.

◆ expire()

void Os::WatchdogTimer::expire ( )

Invoke the callback function with m_parameter.

Definition at line 30 of file WatchdogTimer.cpp.

◆ restart()

WatchdogTimer::WatchdogStatus Os::WatchdogTimer::restart ( )

restart timer with previous value

Definition at line 22 of file WatchdogTimer.cpp.

◆ startMs()

WatchdogTimer::WatchdogStatus Os::WatchdogTimer::startMs	(	I32	delayInMs,
		WatchdogCb	p_callback,
		void *	parameter
	)

Parameters

delayInMs	number of ms to delay.
p_callback	routine to call on time-out
parameter	parameter with which to call routine

Definition at line 18 of file WatchdogTimer.cpp.

◆ startTicks()

WatchdogTimer::WatchdogStatus Os::WatchdogTimer::startTicks	(	I32	delayInTicks,
		WatchdogCb	p_callback,
		void *	parameter
	)