WPILibC++
2019.4.1-3-g655763a
|
#include <Check.h>
Public Member Functions | |
Check (const private_init &) | |
void | Start () |
Start the handle. | |
void | Stop () |
Stop the handle. More... | |
![]() | |
std::shared_ptr< Check > | shared_from_this () |
std::shared_ptr< const Check > | shared_from_this () const |
uv_check_t * | GetRaw () const noexcept |
Get the underlying handle data structure. More... | |
![]() | |
Handle (const Handle &)=delete | |
Handle (Handle &&)=delete | |
Handle & | operator= (const Handle &)=delete |
Handle & | operator= (Handle &&)=delete |
Type | GetType () const noexcept |
Get the type of the handle. More... | |
StringRef | GetTypeName () const noexcept |
Get the name of the type of the handle. More... | |
std::shared_ptr< Loop > | GetLoop () const noexcept |
Get the loop where this handle runs. More... | |
Loop & | GetLoopRef () const noexcept |
Get the loop where this handle runs. More... | |
bool | IsActive () const noexcept |
Check if the handle is active. More... | |
bool | IsClosing () const noexcept |
Check 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 | HasReference () const noexcept |
Check if the given handle is referenced. More... | |
size_t | RawSize () const noexcept |
Return the size of the underlying handle type. More... | |
uv_handle_t * | GetRawHandle () const noexcept |
Get the underlying handle data structure. More... | |
void | SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc) |
Set the functions used for allocating and releasing buffers. More... | |
void | FreeBuf (Buffer &buf) const noexcept |
Free a buffer. More... | |
template<typename T = void> | |
std::shared_ptr< T > | GetData () const |
Gets user-defined data. More... | |
void | SetData (std::shared_ptr< void > data) |
Sets user-defined data. More... | |
void | ReportError (int err) |
Report an error. More... | |
Static Public Member Functions | |
static std::shared_ptr< Check > | Create (Loop &loop) |
Create a check handle. More... | |
static std::shared_ptr< Check > | Create (const std::shared_ptr< Loop > &loop) |
Create a check handle. More... | |
Public Attributes | |
sig::Signal | check |
Signal generated once per loop iteration after polling for I/O. | |
![]() | |
sig::Signal< Error > | error |
Error signal. | |
sig::Signal | closed |
Closed signal. | |
Additional Inherited Members | |
![]() | |
using | Type = uv_handle_type |
![]() | |
Handle (uv_handle_t *uv_handle) | |
void | Keep () noexcept |
void | Release () noexcept |
void | ForceClosed () noexcept |
template<typename F , typename... Args> | |
bool | Invoke (F &&f, Args &&...args) |
![]() | |
static void | AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf) |
static void | DefaultFreeBuf (Buffer &buf) |
Check handle.
Check handles will generate a signal once per loop iteration, right after polling for I/O.
Create a check handle.
loop | Loop object where this handle runs. |
|
inlinestatic |
Create a check handle.
loop | Loop object where this handle runs. |
|
inline |
Stop the handle.
The signal will no longer be generated.