Kanzi Connect  1.1.10
Kanzi Connect C++ API
kanzi::connect::WorkQueueProxyInterface Class Reference

Proxy for Work Queue -> encapsulates the service instance. More...

#include <work_queue_interface.hpp>

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

Public Member Functions

 WorkQueueProxyInterface (AbstractServiceSharedPtr service, WorkQueueInterface *proxiedInterface)
 Constructs a proxy object that bounds the service into the work queue interface. More...
 
- Public Member Functions inherited from kanzi::connect::WorkQueueInterface
virtual ~WorkQueueInterface ()
 Virtual destructor (for SWIG). More...
 

Protected 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)
 Function to call when there is work to be done. More...
 

Detailed Description

Proxy for Work Queue -> encapsulates the service instance.

Constructor & Destructor Documentation

◆ WorkQueueProxyInterface()

kanzi::connect::WorkQueueProxyInterface::WorkQueueProxyInterface ( AbstractServiceSharedPtr  service,
WorkQueueInterface proxiedInterface 
)

Constructs a proxy object that bounds the service into the work queue interface.

Parameters
serviceencapsulated service
proxiedInterfacethe interface that gets proxied.

Member Function Documentation

◆ allocateUniqueHandle()

virtual int64_t kanzi::connect::WorkQueueProxyInterface::allocateUniqueHandle ( )
protectedvirtual

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

Reimplemented from kanzi::connect::WorkQueueInterface.

◆ cancelWorkItem()

virtual void kanzi::connect::WorkQueueProxyInterface::cancelWorkItem ( int64_t  handle)
protectedvirtual

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

Parameters
handlethe handle.

Reimplemented from kanzi::connect::WorkQueueInterface.

◆ notifyItem()

virtual void kanzi::connect::WorkQueueProxyInterface::notifyItem ( ConnectWorkItemSharedPtr  workItem)
protectedvirtual

Function to call when there is work to be done.

Parameters
workItemitem to be put into work queue

Implements kanzi::connect::WorkQueueInterface.


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