uvw::idle_handle Class Reference

The idle handle. More...

#include <idle.h>

Inheritance diagram for uvw::idle_handle:

Collaboration diagram for uvw::idle_handle:

Public Member Functions
int	init () final
	Initializes the handle.
int	start ()
	Starts the handle.
int	stop ()
	Stops the handle.
Public Member Functions inherited from uvw::handle< idle_handle, uv_idle_t, idle_event >
handle_category	category () const noexcept
	Gets the category of the handle.
handle_type	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	send_buffer_size ()
	Gets the size of the send buffer used for the socket.
int	send_buffer_size (int value)
	Sets the size of the send buffer used for the socket.
int	recv_buffer_size ()
	Gets the size of the receive buffer used for the socket.
int	recv_buffer_size (int value)
	Sets the size of the receive buffer used for the socket.
os_file_descriptor	fd () const
	Gets the platform dependent file descriptor equivalent.
Public Member Functions inherited from uvw::resource< T, U, E >
template<typename R = void>
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::uv_type< U >
virtual int	init ()
	Initializes the handle.
loop &	parent () const noexcept
	Gets the loop from which the resource was originated.
const U *	raw () const noexcept
	Gets the underlying raw data structure.
U *	raw () noexcept
	Gets the underlying raw data structure.
Public Member Functions inherited from uvw::emitter< T, E... >
void	on (listener_t< U > f)
	Registers a long-lived listener with the event emitter.
void	reset () noexcept
	Disconnects the listener for the given event type.
void	reset () noexcept
	Disconnects all listeners.
bool	has () const noexcept
	Checks if there is a listener registered for the specific event.

Detailed Description

The idle handle.

Idle handles will emit a idle event 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.

Note

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

To create an idle_handle through a loop, no arguments are required.

Definition at line 29 of file idle.h.

Member Function Documentation

init()

int uvw::idle_handle::init ( )

finalvirtual

Initializes the handle.

Returns

Underlying return value.

Reimplemented from uvw::uv_type< U >.

start()

int uvw::idle_handle::start

(

)

Starts the handle.

An idle event will be emitted once per loop iteration, right before polling the prepare handles.

Returns

Underlying return value.

stop()

int uvw::idle_handle::stop

(

)

Stops the handle.

Returns

Underlying return value.

---

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

• src/uvw/idle.h