WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
wpi::uv::Idle Class Referencefinal

Idle handle. More...

#include <Idle.h>

Inheritance diagram for wpi::uv::Idle:
wpi::uv::HandleImpl< Idle, uv_idle_t > wpi::uv::Handle

Public Member Functions

 Idle (const private_init &)
 
void Start ()
 Start the handle.
 
void Stop ()
 Stop the handle. More...
 
- Public Member Functions inherited from wpi::uv::HandleImpl< Idle, uv_idle_t >
std::shared_ptr< Idleshared_from_this ()
 
std::shared_ptr< const Idleshared_from_this () const
 
uv_idle_tGetRaw () const noexcept
 Get the underlying handle data structure. More...
 
- Public Member Functions inherited from wpi::uv::Handle
 Handle (const Handle &)=delete
 
 Handle (Handle &&)=delete
 
Handleoperator= (const Handle &)=delete
 
Handleoperator= (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< LoopGetLoop () const noexcept
 Get the loop where this handle runs. More...
 
LoopGetLoopRef () 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_tGetRawHandle () 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< IdleCreate (Loop &loop)
 Create an idle handle. More...
 
static std::shared_ptr< IdleCreate (const std::shared_ptr< Loop > &loop)
 Create an idle handle. More...
 

Public Attributes

sig::Signal idle
 Signal generated once per loop iteration prior to Prepare signals.
 
- Public Attributes inherited from wpi::uv::Handle
sig::Signal< Errorerror
 Error signal.
 
sig::Signal closed
 Closed signal.
 

Additional Inherited Members

- Public Types inherited from wpi::uv::Handle
using Type = uv_handle_type
 
- Protected Member Functions inherited from wpi::uv::Handle
 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 Protected Member Functions inherited from wpi::uv::Handle
static void AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf)
 
static void DefaultFreeBuf (Buffer &buf)
 

Detailed Description

Idle handle.

Idle handles will generate a signal once per loop iteration, right before the Prepare handles.

The notable difference with Prepare handles is that when there are active idle handles, the loop will perform a zero timeout poll instead of blocking for I/O.

Warning
Despite the name, idle handles will signal every loop iteration, not when the loop is actually "idle". This also means they can easly become CPU hogs.

Member Function Documentation

static std::shared_ptr<Idle> wpi::uv::Idle::Create ( Loop loop)
static

Create an idle handle.

Parameters
loopLoop object where this handle runs.
static std::shared_ptr<Idle> wpi::uv::Idle::Create ( const std::shared_ptr< Loop > &  loop)
inlinestatic

Create an idle handle.

Parameters
loopLoop object where this handle runs.
void wpi::uv::Idle::Stop ( )
inline

Stop the handle.

The signal will no longer be generated.


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