uvw::poll_handle Class Reference

The poll handle. More...

#include <poll.h>

Inheritance diagram for uvw::poll_handle:

Collaboration diagram for uvw::poll_handle:

Public Member Functions
int	init () final
	Initializes the handle.
int	start (poll_event_flags flags)
	Starts polling the file descriptor.
int	stop ()
	Stops polling the file descriptor.
Public Member Functions inherited from uvw::handle< poll_handle, uv_poll_t, poll_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 poll handle.

Poll handles are used to watch file descriptors for readability, writability and disconnection.

To create a poll_handle through a loop, arguments follow:

• A descriptor that can be:
  • either an int file descriptor
  • or a os_socket_handle socket descriptor

See the official documentation for further details.

Definition at line 59 of file poll.h.

Member Function Documentation

init()

int uvw::poll_handle::init ( )

finalvirtual

Initializes the handle.

Returns

Underlying return value.

Reimplemented from uvw::uv_type< U >.

start()

int uvw::poll_handle::start

(

poll_event_flags

flags

)

Starts polling the file descriptor.

Available flags are:

• poll_handle::event::READABLE
• poll_handle::event::WRITABLE
• poll_handle::event::DISCONNECT
• poll_handle::event::PRIORITIZED

As soon as an event is detected, a poll event is emitted by the handle.

Calling more than once this method will update the flags to which the caller is interested.

Parameters

flags

The events to which the caller is interested.

Returns

Underlying return value.

stop()

int uvw::poll_handle::stop

(

)

Stops polling the file descriptor.

Returns

Underlying return value.

---

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

• src/uvw/poll.h