Diarkis C++Client Library API Document
Diarkis::IDiarkisComponent Class Referenceabstract

Implement this interface to be able to register to a scheduler for periodic update. More...

#include <Component.h>

Inheritance diagram for Diarkis::IDiarkisComponent:

Public Member Functions

virtual std::shared_ptr< IDiarkisEvent< void * > > GetSchedulerAddNotifyEvent ()=0
 An event handler when some event has been added to the scheduler. More...
 
virtual void Update ()=0
 Called on every runtime frame. More...
 
virtual bool WaitCondition (std::chrono::milliseconds maxWait)=0
 Called on every runtime frame. More...
 

Detailed Description

Implement this interface to be able to register to a scheduler for periodic update.

Member Function Documentation

◆ GetSchedulerAddNotifyEvent()

virtual std::shared_ptr<IDiarkisEvent<void*> > Diarkis::IDiarkisComponent::GetSchedulerAddNotifyEvent ( )
pure virtual

An event handler when some event has been added to the scheduler.

An event, for example, receiving the data, will be added to the event scheduler, and after that, the event will be propagated for each module by calling IDiarkisUdp::Update. Therefore, you should call IDiarkisUdp::Update immediately when this event happens if you want to process the event, like receiving data, as soon as fast.

Returns
std::shared_ptr<IDiarkisEvent<void*>>

Implemented in Diarkis::Modules::IDiarkisP2P.

◆ Update()

virtual void Diarkis::IDiarkisComponent::Update ( )
pure virtual

Called on every runtime frame.

◆ WaitCondition()

virtual bool Diarkis::IDiarkisComponent::WaitCondition ( std::chrono::milliseconds  maxWait)
pure virtual

Called on every runtime frame.


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