CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
IoMonitor Class Referencefinal

Wait for I/O events. More...

#include <cc/IoMonitor>

Inheritance diagram for IoMonitor:

Public Member Functions

 IoMonitor ()
 Create a new I/O monitor.
 
void watch (const IoStream &target, IoEvent mask=IoEvent::ReadyReadOrWrite)
 Add an entry to the watch list.
 
void unwatch (const IoStream &target)
 Remove an entry from the watch list.
 
bool wait (const Function< void(const IoActivity &)> &onReady, int timeout=-1)
 Wait for I/O events.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
long useCount () const
 Reference count.
 

Additional Inherited Members

- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 
- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

Wait for I/O events.

Constructor & Destructor Documentation

◆ IoMonitor()

IoMonitor ( )

Create a new I/O monitor.

Member Function Documentation

◆ watch()

void watch ( const IoStream & target,
IoEvent mask = IoEvent::ReadyReadOrWrite )

Add an entry to the watch list.

Parameters
targetI/O stream to monitor
maskI/O event mask

◆ unwatch()

void unwatch ( const IoStream & target)

Remove an entry from the watch list.

Parameters
targetI/O stream to stop monitoring

◆ wait()

bool wait ( const Function< void(const IoActivity &)> & onReady,
int timeout = -1 )

Wait for I/O events.

Parameters
onReadyCallback function to handle I/O events
timeoutTimeout in milliseconds (or infinite if < 0)