The async handle. More...
#include <async.h>
Inheritance diagram for uvw::async_handle:
Collaboration diagram for uvw::async_handle:
Public Member Functions | |
| int | init () final |
| Initializes the handle. | |
| int | send () |
| Wakeups the event loop and emits the async event. | |
 Public Member Functions inherited from uvw::handle< async_handle, uv_async_t, async_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 async handle.
Async handles allow the user to wakeup the event loop and get an event emitted from another thread.
To create an async_handle through a loop, no arguments are required.
Member Function Documentation
◆ init()
|
finalvirtual |
Initializes the handle.
Unlike other handle initialization functions, it immediately starts the handle.
- Returns
- Underlying return value.
Reimplemented from uvw::uv_type< U >.
◆ send()
| int uvw::async_handle::send | ( | ) |
Wakeups the event loop and emits the async event.
It’s safe to call this function from any thread.
An async event is emitted on the loop thread.
See the official documentation for further details.
- Returns
- Underlying return value.
The documentation for this class was generated from the following file:
- src/uvw/async.h
