uvw 2.12.1
Loading...
Searching...
No Matches
uvw::PollHandle Class Referencefinal

The PollHandle handle. More...

#include <poll.h>

Inheritance diagram for uvw::PollHandle:
Collaboration diagram for uvw::PollHandle:

Public Member Functions

bool init ()
 Initializes the handle.
 
void start (Flags< Event > flags)
 Starts polling the file descriptor.
 
void start (Event event)
 Starts polling the file descriptor.
 
void stop ()
 Stops polling the file descriptor.
 
- Public Member Functions inherited from uvw::Handle< PollHandle, uv_poll_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< PollHandle, uv_poll_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< PollHandle, uv_poll_t >
Looploop () const noexcept
 Gets the loop from which the resource was originated.
 
const uv_poll_t * raw () const noexcept
 Gets the underlying raw data structure.
 
uv_poll_t * raw () noexcept
 Gets the underlying raw data structure.
 
- Public Member Functions inherited from uvw::Emitter< PollHandle >
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

- Public Types inherited from uvw::Emitter< PollHandle >
- Static Public Member Functions inherited from uvw::UnderlyingType< PollHandle, uv_poll_t >
static std::shared_ptr< PollHandlecreate (Args &&...args)
 Creates a new resource of the given type.
 
- Protected Types inherited from uvw::Resource< PollHandle, uv_poll_t >
- Protected Member Functions inherited from uvw::Handle< PollHandle, uv_poll_t >
- Protected Member Functions inherited from uvw::Resource< PollHandle, uv_poll_t >
- Protected Member Functions inherited from uvw::UnderlyingType< PollHandle, uv_poll_t >
- Protected Member Functions inherited from uvw::Emitter< PollHandle >
- Static Protected Member Functions inherited from uvw::Handle< PollHandle, uv_poll_t >

Detailed Description

The PollHandle handle.

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

To create a PollHandle through a Loop, arguments follow:

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

See the official documentation for further details.

Definition at line 60 of file poll.h.

Member Function Documentation

◆ init()

bool uvw::PollHandle::init ( )

Initializes the handle.

Returns
True in case of success, false otherwise.

◆ start() [1/2]

void uvw::PollHandle::start ( Event event)

Starts polling the file descriptor.

Available flags are:

  • PollHandle::Event::READABLE
  • PollHandle::Event::WRITABLE
  • PollHandle::Event::DISCONNECT
  • PollHandle::Event::PRIORITIZED

As soon as an event is detected, a PollEvent is emitted by the handle.
It could happen that ErrorEvent events are emitted while running.

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

Parameters
eventThe event to which the caller is interested.

◆ start() [2/2]

void uvw::PollHandle::start ( Flags< Event > flags)

Starts polling the file descriptor.

Available flags are:

  • PollHandle::Event::READABLE
  • PollHandle::Event::WRITABLE
  • PollHandle::Event::DISCONNECT
  • PollHandle::Event::PRIORITIZED

As soon as an event is detected, a PollEvent is emitted by the handle.
It could happen that ErrorEvent events are emitted while running.

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

Parameters
flagsThe events to which the caller is interested.

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