Very Simple Cross-Platform Library
Public Member Functions | List of all members
hu::varadiistvan::scpl::io::WaitableEvent Class Reference

#include <WaitableEvent.h>

Inheritance diagram for hu::varadiistvan::scpl::io::WaitableEvent:
hu::varadiistvan::scpl::io::Failable

Public Member Functions

 WaitableEvent (Waiter *waiter=0)
 
virtual ~WaitableEvent ()
 
void fire ()
 
bool check ()
 
- Public Member Functions inherited from hu::varadiistvan::scpl::io::Failable
 Failable ()
 
bool failed () const
 
errorCode_t getErrorCode () const
 
void repair ()
 

Additional Inherited Members

- Protected Member Functions inherited from hu::varadiistvan::scpl::io::Failable
void setErrorCode (errorCode_t ec)
 

Detailed Description

An event on which one can wait with a waiter.

Definition at line 44 of file WaitableEvent.h.

Constructor & Destructor Documentation

◆ WaitableEvent()

hu::varadiistvan::scpl::io::WaitableEvent::WaitableEvent ( Waiter waiter = 0)

Construct the event.

Parameters
waiterthe waiter to be used for waiting. If given, the check() function will always return immediately. If not given, the check() function may block and returns only when the event is fired.

◆ ~WaitableEvent()

virtual hu::varadiistvan::scpl::io::WaitableEvent::~WaitableEvent ( )
virtual

Destroy the event.

Member Function Documentation

◆ check()

bool hu::varadiistvan::scpl::io::WaitableEvent::check ( )

Check if the event is fired or not. If so, the fired status will be cleared.

◆ fire()

void hu::varadiistvan::scpl::io::WaitableEvent::fire ( )

Fire the event.


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