#include <wpinet/uv/Idle.h>

Inheritance diagram for wpi::uv::Idle:

Public Member Functions
	Idle (const private_init &)

	~Idle () noexcept override=default

void	Start ()
	Start the handle. More...

void	Stop ()
	Stop the handle. More...

Public Member Functions inherited from wpi::uv::HandleImpl< Idle, uv_idle_t >
std::shared_ptr< Idle >	shared_from_this ()

std::shared_ptr< const Idle >	shared_from_this () const

uv_idle_t *	GetRaw () const noexcept
	Get the underlying handle data structure. More...

Public Member Functions inherited from wpi::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. More...

std::string_view	GetTypeName () const noexcept
	Get the name of the type of the handle. More...

std::shared_ptr< Loop >	GetLoop () const noexcept
	Get the loop where this handle runs. More...

Loop &	GetLoopRef () const noexcept
	Get the loop where this handle runs. More...

bool	IsActive () const noexcept
	Check if the handle is active. More...

bool	IsClosing () const noexcept
	Check if a handle is closing or closed. More...

void	Close () noexcept
	Request handle to be closed. More...

void	SetLoopClosing (bool loopClosing) noexcept
	Set if the loop is closing. More...

bool	IsLoopClosing () const noexcept
	Get the loop closing status. More...

void	Reference () noexcept
	Reference the given handle. More...

void	Unreference () noexcept
	Unreference the given handle. More...

bool	HasReference () const noexcept
	Check if the given handle is referenced. More...

size_t	RawSize () const noexcept
	Return the size of the underlying handle type. More...

uv_handle_t *	GetRawHandle () const noexcept
	Get the underlying handle data structure. More...

void	SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc)
	Set the functions used for allocating and releasing buffers. More...

void	FreeBuf (Buffer &buf) const noexcept
	Free a buffer. More...

template<typename T = void>
std::shared_ptr< T >	GetData () const
	Gets user-defined data. More...

void	SetData (std::shared_ptr< void > data)
	Sets user-defined data. More...

void	ReportError (int err) const
	Report an error. More...

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

static std::shared_ptr< Idle >	Create (const std::shared_ptr< Loop > &loop)
	Create an idle handle. More...

Public Attributes
sig::Signal	idle
	Signal generated once per loop iteration prior to Prepare signals. More...

Public Attributes inherited from wpi::uv::Handle
sig::Signal< Error >	error
	Error signal. More...

sig::Signal	closed
	Closed signal. More...

Additional Inherited Members
Public Types inherited from wpi::uv::Handle
using	Type = uv_handle_type

Protected Member Functions inherited from wpi::uv::HandleImpl< Idle, uv_idle_t >
	HandleImpl ()

Protected Member Functions inherited from wpi::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::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::uv::Idle::Idle ( const private_init & )

inlineexplicit

◆ ~Idle()

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

overridedefaultnoexcept

Member Function Documentation

◆ Create() [1/2]

static std::shared_ptr< Idle > wpi::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]

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

static

Create an idle handle.

Parameters

loop	Loop object where this handle runs.

◆ Start()

void wpi::uv::Idle::Start ( )

Start the handle.

◆ Stop()

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

inline

Stop the handle.

The signal will no longer be generated.

Member Data Documentation

◆ idle

sig::Signal wpi::uv::Idle::idle

Signal generated once per loop iteration prior to Prepare signals.

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

wpinet/uv/Idle.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members