uvw::IdleHandle Class Reference

The IdleHandle handle. More...

#include <idle.h>

Inheritance diagram for uvw::IdleHandle:

Collaboration diagram for uvw::IdleHandle:

Public Member Functions
bool	init ()
	Initializes the handle.
void	start ()
	Starts the handle.
void	stop ()
	Stops the handle.
Public Member Functions inherited from uvw::Handle< IdleHandle, uv_idle_t >
HandleCategory	category () const noexcept
	Gets the category of the handle.
HandleType	type () const noexcept
	Gets the type of the handle.
bool	active () const noexcept
	Checks if the handle is active.
bool	closing () const noexcept
	Checks if a handle is closing or closed.
void	close () noexcept
	Request handle to be closed.
void	reference () noexcept
	Reference the given handle.
void	unreference () noexcept
	Unreference the given handle.
bool	referenced () const noexcept
	Checks if the given handle referenced.
std::size_t	size () const noexcept
	Returns the size of the underlying handle type.
int	sendBufferSize ()
	Gets the size of the send buffer used for the socket.
bool	sendBufferSize (int value)
	Sets the size of the send buffer used for the socket.
int	recvBufferSize ()
	Gets the size of the receive buffer used for the socket.
bool	recvBufferSize (int value)
	Sets the size of the receive buffer used for the socket.
OSFileDescriptor	fd () const
	Gets the platform dependent file descriptor equivalent.
Public Member Functions inherited from uvw::Resource< IdleHandle, uv_idle_t >
std::shared_ptr< R >	data () const
	Gets user-defined data. uvw won't use this field in any case.
void	data (std::shared_ptr< void > uData)
	Sets arbitrary data. uvw won't use this field in any case.
Public Member Functions inherited from uvw::UnderlyingType< IdleHandle, uv_idle_t >
Loop &	loop () const noexcept
	Gets the loop from which the resource was originated.
const uv_idle_t *	raw () const noexcept
	Gets the underlying raw data structure.
uv_idle_t *	raw () noexcept
	Gets the underlying raw data structure.
Public Member Functions inherited from uvw::Emitter< IdleHandle >
Connection< E >	on (Listener< E > f)
	Registers a long-lived listener with the event emitter.
Connection< E >	once (Listener< E > f)
	Registers a short-lived listener with the event emitter.
void	erase (Connection< E > conn) noexcept
	Disconnects a listener from the event emitter.
void	clear () noexcept
	Disconnects all the listeners for the given event type.
void	clear () noexcept
	Disconnects all the listeners.
bool	empty () const noexcept
	Checks if there are listeners registered for the specific event.
bool	empty () const noexcept
	Checks if there are listeners registered with the event emitter.

Additional Inherited Members
Static Public Member Functions inherited from uvw::UnderlyingType< IdleHandle, uv_idle_t >
static std::shared_ptr< IdleHandle >	create (Args &&...args)
	Creates a new resource of the given type.

Detailed Description

The IdleHandle handle.

Idle handles will emit a IdleEvent event once per loop iteration, right before the PrepareHandle 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.

Note

Despite the name, idle handles will emit events on every loop iteration, not when the loop is actually idle.

To create an IdleHandle through a Loop, no arguments are required.

Definition at line 33 of file idle.h.

Member Function Documentation

init()

bool uvw::IdleHandle::init

(

)

Initializes the handle.

Returns

True in case of success, false otherwise.

start()

void uvw::IdleHandle::start

(

)

Starts the handle.

A IdleEvent event will be emitted once per loop iteration, right before polling the PrepareHandle handles.

---

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

• src/uvw/idle.h