winss::WaitTimeoutItem Struct Reference

Holds timeout information such that when a timeout occurs the multiplexer knows how to handle it. More...

#include <wait_multiplexer.hpp>

Public Member Functions
bool	operator< (const WaitTimeoutItem &rhs) const
	Used to order the timeout items such as next item is the one with the point in time closest to now. More...

Public Attributes
std::string	group
	Used to identify the group of items when removing them. More...
std::chrono::system_clock::time_point	timeout
	The point in time the timeout will be in effect. More...
Callback	callback
	The call back for when the timeout occurs. More...

Detailed Description

Holds timeout information such that when a timeout occurs the multiplexer knows how to handle it.

The multiplexer can handle multiple timeout items.

Member Function Documentation

bool winss::WaitTimeoutItem::operator<

(

const WaitTimeoutItem &

rhs

)

const

Used to order the timeout items such as next item is the one with the point in time closest to now.

Parameters

rhs	The other timeout item.

Returns

True if this point in time is less than rhs otherwise false.

References timeout.

Member Data Documentation

Callback winss::WaitTimeoutItem::callback

The call back for when the timeout occurs.

Referenced by winss::WaitMultiplexer::AddTriggeredCallback(), winss::WaitMultiplexer::Start(), winss::WaitMultiplexer::Stop(), and winss::WaitMultiplexer::WaitMultiplexer().

std::string winss::WaitTimeoutItem::group

Used to identify the group of items when removing them.

Referenced by winss::WaitMultiplexer::AddTimeoutCallback(), and winss::WaitMultiplexer::WaitMultiplexer().

std::chrono::system_clock::time_point winss::WaitTimeoutItem::timeout

The point in time the timeout will be in effect.

Referenced by winss::WaitMultiplexer::GetTimeout(), operator<(), winss::WaitMultiplexer::Start(), and winss::WaitMultiplexer::WaitMultiplexer().

---

The documentation for this struct was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/latest/lib/winss/wait_multiplexer.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/latest/lib/winss/wait_multiplexer.cpp