ustd::timeout Class Reference

muwerk Timeout Class More...

#include <timeout.h>

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

Detailed Description

muwerk Timeout Class

Implements a helper class for handling timeouts in milliseconds. See ustd::utimeout for a high precision implmentation with microsecond resolution.

The following example based on a reconnection timeout illustrates the usage of this class:

#include <scheduler.h>
#include <timeout>
 
ustd::Scheduler sched;
ustd::timeout   connectTimeout = 15000; // 15 seconds in millliseconds
 
void appLoop();
 
void someTask() {
    // This is called every 50ms (50000us)
    // Do things here..
 
    state == getCurrentState();
 
    if ( state == RECONNECTING ) {
        if ( connectTimeout.test() ) {
            // this happens when the timeout occur
            DBG("Failed to connect");
            // do things here....
        }
    } else if ( state == CONNECTED ) {
        connectTimeout.reset();
 
    } else if ( state == DISCONNECTED ) {
        state == RECONNECTING
        connectTimeout.reset()
        // start reconnection attempt here
    }
}
 
void setup() {
    // Create a task for the main application loop code:
    int tID = sched.add(appLoop, "main");
 
    // Create a second task that is called every 50ms
    sched.add(someTask, "someTask", 50000L);
}

Constructor & Destructor Documentation

timeout()

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

inline

Creates a timeout

Parameters

value

(optional, default 0) Timeout value in milliseconds.

Member Function Documentation

operator unsigned long()

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

inline

Returns the current timeout value

Returns

Timeout value in milliseconds.

operator=()

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

inline

Assigns a new timeout value

Parameters

value

Timeout value in milliseconds.

reset()

void ustd::timeout::reset ( )

inline

Resets the timeout

test()

bool ustd::timeout::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