uvcc
libuv C++ bindings
uv::check Class Reference

Check handle. More...

#include "handle-misc.hpp"

Inheritance diagram for uv::check:
uv::handle

Public Types

using uv_t = ::uv_check_t
 
using on_check_t = std::function< void(check _handle) >
 The function type of the handle's callback.
 
- Public Types inherited from uv::handle
using uv_t = ::uv_handle_t
 
using on_destroy_t = std::function< void(void *_data) >
 The function type of the callback called when the handle has been closed and about to be destroyed. More...
 

Public Member Functions

 check (const check &)=default
 
checkoperator= (const check &)=default
 
 check (check &&) noexcept=default
 
checkoperator= (check &&) noexcept=default
 
 check (uv::loop &_loop)
 Create an check handle.
 
on_check_ton_check () const noexcept
 Set the handle's callback.
 
int start () const
 Start the handle. More...
 
template<class _Cb_ , typename... _Args_, typename = std::enable_if_t< std::is_convertible< decltype(std::bind(std::declval< _Cb_ >(), std::placeholders::_1, static_cast< _Args_&& >(std::declval< _Args_ >())...)), on_check_t >::value >>
int start (_Cb_ &&_cb, _Args_ &&... _args) const
 Start the handle with the given callback. More...
 
int stop () const noexcept
 Stop the handle, the callback will no longer be called.
 
 operator const uv_t * () const noexcept
 
 operator uv_t * () noexcept
 
- Public Member Functions inherited from uv::handle
 handle (const handle &_that)
 
handleoperator= (const handle &_that)
 
 handle (handle &&_that) noexcept
 
handleoperator= (handle &&_that) noexcept
 
void swap (handle &_that) noexcept
 
std::uintptr_t id () const noexcept
 The unique ID of the instance managed by this handle variable or 0 if the handle is void.
 
long nrefs () const noexcept
 The current number of existing references to the same object as this handle variable refers to.
 
int uv_status () const noexcept
 The status value returned by the last executed libuv API function on this handle.
 
on_destroy_ton_destroy () const noexcept
 
::uv_handle_type type () const noexcept
 The tag indicating the libuv type of the handle.
 
const char * type_name () const noexcept
 A string containing the name of the handle type.
 
uv::loop loop () const noexcept
 The libuv loop where the handle is running on. More...
 
void *& data () const noexcept
 The pointer to the user-defined arbitrary data. libuv and uvcc does not use this field.
 
int is_active () const noexcept
 Check if the handle is active. More...
 
int is_closing () const noexcept
 Check if the handle is closing or closed. More...
 
::uv_os_fd_t fileno () const noexcept
 Get the platform dependent handle/file descriptor. More...
 
 operator const uv_t * () const noexcept
 
 operator uv_t * () noexcept
 
 operator bool () const noexcept
 Equivalent to (id() and uv_status() >= 0).
 
void attached (bool _state) const noexcept
 
bool attached () const noexcept
 

Detailed Description

Check handle.

See also
libuv API documentation: uv_check_t — Check handle.

Definition at line 842 of file handle-misc.hpp.

Member Function Documentation

◆ start() [1/2]

int uv::check::start ( ) const
inline

Start the handle.

Note
On successful start this function adds an extra reference to the handle instance, which is released when the counterpart function stop() is called. Repeated calls don't change the reference count.
See also
libuv API documentation: uv_check_t — Check handle.

Definition at line 912 of file handle-misc.hpp.

◆ start() [2/2]

template<class _Cb_ , typename... _Args_, typename = std::enable_if_t< std::is_convertible< decltype(std::bind(std::declval< _Cb_ >(), std::placeholders::_1, static_cast< _Args_&& >(std::declval< _Args_ >())...)), on_check_t >::value >>
int uv::check::start ( _Cb_ &&  _cb,
_Args_ &&...  _args 
) const
inline

Start the handle with the given callback.

This is equivalent for

check.on_check() = std::bind(
std::forward< _Cb_ >(_cb), std::placeholders::_1, std::forward< _Args_ >(_args)...
);
check.start();
See also
check::start()

Definition at line 958 of file handle-misc.hpp.


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