Leosac  0.8.0
Open Source Access Control
Public Member Functions | List of all members
Leosac::update::UpdateBackend Class Referenceabstract

#include <UpdateService.hpp>

Public Member Functions

virtual std::vector< UpdateDescriptorPtr > check_update ()=0
 Check for updates against arbitrary, module-owned object. More...
 
virtual IUpdatePtr create_update (const UpdateDescriptor &ud, const ExecutionContext &)=0
 Create an update based on the UpdateDescriptor ud. More...
 
virtual void ack_update (IUpdatePtr u, const ExecutionContext &)=0
 Acknowledge the pending update u. More...
 
virtual void cancel_update (IUpdatePtr u, const ExecutionContext &)=0
 Cancel (not rollback) the pending update u. More...
 

Detailed Description

Definition at line 71 of file UpdateService.hpp.

Member Function Documentation

◆ ack_update()

virtual void Leosac::update::UpdateBackend::ack_update ( IUpdatePtr  u,
const ExecutionContext &   
)
pure virtual

Acknowledge the pending update u.

If the update u doesn't target your module, ignore it.

◆ cancel_update()

virtual void Leosac::update::UpdateBackend::cancel_update ( IUpdatePtr  u,
const ExecutionContext &   
)
pure virtual

Cancel (not rollback) the pending update u.

If the update u doesn't target your module, ignore it.

◆ check_update()

virtual std::vector<UpdateDescriptorPtr> Leosac::update::UpdateBackend::check_update ( )
pure virtual

Check for updates against arbitrary, module-owned object.

The update returned by check update are supposed to be transient. They are informative only and simply indicates that an update is needed.

Module specific websocket-handler should be called in order to to perform other operation wrt updates.

◆ create_update()

virtual IUpdatePtr Leosac::update::UpdateBackend::create_update ( const UpdateDescriptor &  ud,
const ExecutionContext &   
)
pure virtual

Create an update based on the UpdateDescriptor ud.

If the ud cannot be casted back to the implementation of your module, make sure return nullptr from this method because it means the update creation wasn't targeted at your module.

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