Kanzi Connect  1.1.10
Kanzi Connect C++ API
Public Member Functions | List of all members
kanzi::connect::WorkQueueInterface Class Referenceabstract

Interface for the work queue. Used to propagate work items from services to event-based work loop. More...

#include <work_queue_interface.hpp>

Inheritance diagram for kanzi::connect::WorkQueueInterface:
kanzi::connect::Client kanzi::connect::ClientRemoteServiceHost kanzi::connect::WorkQueueProxyInterface

Public Member Functions

virtual int64_t allocateUniqueHandle ()
 Optionally implementable method that should return a handle that can later on be used cancel work item holding that identifier. More...
 
virtual void cancelWorkItem (int64_t handle)
 Cancels a work item holding an handle previously allocated using allocateUniqueHandle() More...
 
virtual void notifyItem (ConnectWorkItemSharedPtr workItem)=0
 Function to call when there is work to be done. More...
 
virtual ~WorkQueueInterface ()
 Virtual destructor (for SWIG). More...
 

Detailed Description

Interface for the work queue. Used to propagate work items from services to event-based work loop.

Constructor & Destructor Documentation

◆ ~WorkQueueInterface()

virtual kanzi::connect::WorkQueueInterface::~WorkQueueInterface ( )
inlinevirtual

Virtual destructor (for SWIG).

Member Function Documentation

◆ allocateUniqueHandle()

virtual int64_t kanzi::connect::WorkQueueInterface::allocateUniqueHandle ( )
inlinevirtual

Optionally implementable method that should return a handle that can later on be used cancel work item holding that identifier.

Reimplemented in kanzi::connect::Client, and kanzi::connect::WorkQueueProxyInterface.

◆ cancelWorkItem()

virtual void kanzi::connect::WorkQueueInterface::cancelWorkItem ( int64_t  handle)
inlinevirtual

Cancels a work item holding an handle previously allocated using allocateUniqueHandle()

Parameters
handlethe handle.

Reimplemented in kanzi::connect::Client, and kanzi::connect::WorkQueueProxyInterface.

◆ notifyItem()

virtual void kanzi::connect::WorkQueueInterface::notifyItem ( ConnectWorkItemSharedPtr  workItem)
pure virtual

Function to call when there is work to be done.

Parameters
workItemitem to be put into work queue

Implemented in kanzi::connect::Client, and kanzi::connect::WorkQueueProxyInterface.

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