ustd::utimeout Class Reference

muwerk High Precision Timeout Class More...

#include <timeout.h>

Public Member Functions
	utimeout (unsigned long value=0)
utimeout &	operator= (const unsigned long value)
	operator unsigned long () const
bool	test () const
void	reset ()

Detailed Description

muwerk High Precision Timeout Class

Implements a helper class for handling timeouts in microseconds. See ustd::timeout for a lower precision implmentation with millisecond resolution and with a usage example.

Constructor & Destructor Documentation

utimeout()

ustd::utimeout::utimeout ( unsigned long  value = 0 )

inline

Creates a timout

Parameters

value

(optional, default 0) Timeout value in microseconds.

Member Function Documentation

operator unsigned long()

ustd::utimeout::operator unsigned long ( ) const

inline

Returns the current timeout value

Returns

Timeout value in microseconds.

operator=()

utimeout & ustd::utimeout::operator= ( const unsigned long  value )

inline

Assigns a new timeout value

Parameters

value

Timeout value in microseconds.

reset()

void ustd::utimeout::reset ( )

inline

Resets the timeout

test()

bool ustd::utimeout::test ( ) const

inline

Returns if a timeout has occurred

Returns

true if a timeout has occurred since last reset

---

The documentation for this class was generated from the following file:

• timeout.h