The CheckHandle handle. More...
#include <check.h>
Inheritance diagram for uvw::CheckHandle:
Collaboration diagram for uvw::CheckHandle:
Public Member Functions | |
| bool | init () |
| Initializes the handle. More... | |
| void | start () |
| Starts the handle. More... | |
| void | stop () |
| Stops the handle. | |
 Public Member Functions inherited from uvw::Handle< CheckHandle, uv_check_t > | |
| HandleCategory | category () const noexcept |
| Gets the category of the handle. More... | |
| HandleType | type () const noexcept |
| Gets the type of the handle. More... | |
| bool | active () const noexcept |
| Checks if the handle is active. More... | |
| bool | closing () const noexcept |
| Checks if a handle is closing or closed. More... | |
| void | close () noexcept |
| Request handle to be closed. More... | |
| void | reference () noexcept |
| Reference the given handle. More... | |
| void | unreference () noexcept |
| Unreference the given handle. More... | |
| bool | referenced () const noexcept |
| Checks if the given handle referenced. More... | |
| std::size_t | size () const noexcept |
| Returns the size of the underlying handle type. More... | |
| int | sendBufferSize () |
| Gets the size of the send buffer used for the socket. More... | |
| bool | sendBufferSize (int value) |
| Sets the size of the send buffer used for the socket. More... | |
| int | recvBufferSize () |
| Gets the size of the receive buffer used for the socket. More... | |
| bool | recvBufferSize (int value) |
| Sets the size of the receive buffer used for the socket. More... | |
| OSFileDescriptor | fd () const |
| Gets the platform dependent file descriptor equivalent. More... | |
| Public Member Functions inherited from uvw::Resource< T, U > | |
| template<typename R = void> | |
| std::shared_ptr< R > | data () const |
Gets user-defined data. uvw won't use this field in any case. More... | |
| void | data (std::shared_ptr< void > uData) |
Sets arbitrary data. uvw won't use this field in any case. More... | |
| Public Member Functions inherited from uvw::UnderlyingType< T, U > | |
| Loop & | loop () const noexcept |
| Gets the loop from which the resource was originated. More... | |
| const U * | raw () const noexcept |
| Gets the underlying raw data structure. More... | |
| U * | raw () noexcept |
| Gets the underlying raw data structure. More... | |
| Public Member Functions inherited from uvw::Emitter< T > | |
| template<typename E > | |
| Connection< E > | on (Listener< E > f) |
| Registers a long-lived listener with the event emitter. More... | |
| template<typename E > | |
| Connection< E > | once (Listener< E > f) |
| Registers a short-lived listener with the event emitter. More... | |
| template<typename E > | |
| void | erase (Connection< E > conn) noexcept |
| Disconnects a listener from the event emitter. More... | |
| template<typename E > | |
| void | clear () noexcept |
| Disconnects all the listeners for the given event type. | |
| void | clear () noexcept |
| Disconnects all the listeners. | |
| template<typename E > | |
| bool | empty () const noexcept |
| Checks if there are listeners registered for the specific event. More... | |
| bool | empty () const noexcept |
| Checks if there are listeners registered with the event emitter. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from uvw::UnderlyingType< T, U > | |
| template<typename... Args> | |
| static std::shared_ptr< T > | create (Args &&...args) |
| Creates a new resource of the given type. More... | |
Detailed Description
The CheckHandle handle.
Check handles will emit a CheckEvent event once per loop iteration, right after polling for I/O.
To create a CheckHandle through a Loop, no arguments are required.
Member Function Documentation
◆ init()
| bool uvw::CheckHandle::init | ( | ) |
Initializes the handle.
- Returns
- True in case of success, false otherwise.
◆ start()
| void uvw::CheckHandle::start | ( | ) |
Starts the handle.
A CheckEvent event will be emitted once per loop iteration, right after polling for I/O.
The documentation for this class was generated from the following file:
- src/uvw/check.h
