wpi::net::uv::Idle Class Reference

Idle handle. More...

#include <wpi/net/uv/Idle.hpp>

Inheritance diagram for wpi::net::uv::Idle:

Public Member Functions
	Idle (const private_init &)
	~Idle () noexcept override=default
void	Start ()
	Start the handle.
void	Stop ()
	Stop the handle.
Public Member Functions inherited from wpi::net::uv::HandleImpl< Idle, uv_idle_t >
std::shared_ptr< Idle >	shared_from_this ()
uv_idle_t *	GetRaw () const noexcept
	Get the underlying handle data structure.
Public Member Functions inherited from wpi::net::uv::Handle
	Handle (const Handle &)=delete
	Handle (Handle &&)=delete
Handle &	operator= (const Handle &)=delete
Handle &	operator= (Handle &&)=delete
virtual	~Handle () noexcept
Type	GetType () const noexcept
	Get the type of the handle.
std::string_view	GetTypeName () const noexcept
	Get the name of the type of the handle.
std::shared_ptr< Loop >	GetLoop () const noexcept
	Get the loop where this handle runs.
Loop &	GetLoopRef () const noexcept
	Get the loop where this handle runs.
bool	IsActive () const noexcept
	Check if the handle is active.
bool	IsClosing () const noexcept
	Check if a handle is closing or closed.
void	Close () noexcept
	Request handle to be closed.
void	SetLoopClosing (bool loopClosing) noexcept
	Set if the loop is closing.
bool	IsLoopClosing () const noexcept
	Get the loop closing status.
void	Reference () noexcept
	Reference the given handle.
void	Unreference () noexcept
	Unreference the given handle.
bool	HasReference () const noexcept
	Check if the given handle is referenced.
size_t	RawSize () const noexcept
	Return the size of the underlying handle type.
uv_handle_t *	GetRawHandle () const noexcept
	Get the underlying handle data structure.
void	SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc)
	Set the functions used for allocating and releasing buffers.
void	FreeBuf (Buffer &buf) const noexcept
	Free a buffer.
template<typename T = void>
std::shared_ptr< T >	GetData () const
	Gets user-defined data.
void	SetData (std::shared_ptr< void > data)
	Sets user-defined data.
void	SetLogger (wpi::util::Logger *logger)
	Sets logger.
wpi::util::Logger *	GetLogger () const
	Gets logger.
void	ReportError (int err) const
	Report an error.

Static Public Member Functions
static std::shared_ptr< Idle >	Create (Loop &loop)
	Create an idle handle.
static std::shared_ptr< Idle >	Create (const std::shared_ptr< Loop > &loop)
	Create an idle handle.

Public Attributes
wpi::util::sig::Signal	idle
	Signal generated once per loop iteration prior to Prepare signals.
Public Attributes inherited from wpi::net::uv::Handle
wpi::util::sig::Signal< Error >	error
	Error signal.
wpi::util::sig::Signal	closed
	Closed signal.

Additional Inherited Members
Public Types inherited from wpi::net::uv::Handle
using	Type = uv_handle_type
Protected Member Functions inherited from wpi::net::uv::HandleImpl< Idle, uv_idle_t >
	HandleImpl ()
Protected Member Functions inherited from wpi::net::uv::Handle
	Handle (uv_handle_t *uv_handle)
void	Keep () noexcept
void	Release () noexcept
void	ForceClosed () noexcept
template<typename F, typename... Args>
bool	Invoke (F &&f, Args &&... args) const
Static Protected Member Functions inherited from wpi::net::uv::Handle
static void	AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf)
static void	DefaultFreeBuf (Buffer &buf)

Detailed Description

Idle handle.

Idle handles will generate a signal once per loop iteration, right before the Prepare handles.

The notable difference with Prepare handles is that when there are active idle handles, the loop will perform a zero timeout poll instead of blocking for I/O.

Warning

Despite the name, idle handles will signal every loop iteration, not when the loop is actually "idle". This also means they can easily become CPU hogs.

Constructor & Destructor Documentation

Idle()

wpi::net::uv::Idle::Idle ( const private_init & )

inlineexplicit

~Idle()

wpi::net::uv::Idle::~Idle ( )

overridedefaultnoexcept

Member Function Documentation

Create() [1/2]

std::shared_ptr< Idle > wpi::net::uv::Idle::Create ( const std::shared_ptr< Loop > & loop )

inlinestatic

Create an idle handle.

Parameters

loop	Loop object where this handle runs.

Create() [2/2]

std::shared_ptr< Idle > wpi::net::uv::Idle::Create ( Loop & loop )

static

Create an idle handle.

Parameters

loop	Loop object where this handle runs.

Start()

void wpi::net::uv::Idle::Start

(

)

Start the handle.

Stop()

void wpi::net::uv::Idle::Stop ( )

inline

Stop the handle.

The signal will no longer be generated.

Member Data Documentation

idle

wpi::util::sig::Signal wpi::net::uv::Idle::idle

Signal generated once per loop iteration prior to Prepare signals.

---

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

• wpi/net/uv/Idle.hpp