peak::core::Timeout Class Reference

Represents a timeout value in milliseconds. More...

#include <peak/common/peak_timeout.hpp>

Public Member Functions
	Timeout (uint64_t timeout=0) noexcept
	Timeout (std::chrono::milliseconds timeout) noexcept
	operator uint64_t () const

Static Public Attributes
static const uint64_t	INFINITE_TIMEOUT = PEAK_INFINITE_TIMEOUT
	The constant defining an infinite timeout. More...

Detailed Description

Represents a timeout value in milliseconds.

Use INFINITE_TIMEOUT for an infinite timeout.

Since

1.1

Constructor & Destructor Documentation

Timeout() [1/2]

peak::core::Timeout::Timeout ( uint64_t  timeout = 0 )

inlinenoexcept

Timeout() [2/2]

peak::core::Timeout::Timeout ( std::chrono::milliseconds  timeout )

inlinenoexcept

Member Function Documentation

operator uint64_t()

peak::core::Timeout::operator uint64_t ( ) const

inline

Member Data Documentation

INFINITE_TIMEOUT

const uint64_t peak::core::Timeout::INFINITE_TIMEOUT = PEAK_INFINITE_TIMEOUT

static

The constant defining an infinite timeout.

The corresponding function will only return after the operation is completed.

---

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

• peak/common/peak_timeout.hpp