kanzi::connect::ConnectWorkItem Class Reference

Base class for work items that are passed through the workitem queue. More...

#include <connect_work_item.hpp>

Inheritance diagram for kanzi::connect::ConnectWorkItem:

Classes
class	TimerInfo

Public Types
enum class	ExecutionContext { RUN_IN_MAIN_THREAD , RUN_IN_WORKER_THREAD }
	How to execute the work item. More...
typedef function< void(void)>	Executor
	Callback function that is dispatched to work queue and is used to execute work.
enum	Priority { LowPriority = 1 , NormalPriority = 10 , HighPriority = 20 , SystemPriority = 30 }
	Priority levels for the work items. More...
enum	Type { Base , User = 1000 }
	Types for the work items. More...

Public Member Functions
	ConnectWorkItem (int32_t type=Base, int32_t priority=NormalPriority, ExecutionContext executionContext=ExecutionContext::RUN_IN_MAIN_THREAD)
	Constructor.
bool	deadlineIsEarlierThan (const ConnectWorkItem &workItem) const
	Checks whether this object(s) deadline is earlier than with the "other" item.
ConnectWorkItem::Executor	getExecutor () const
	Retrieve the executor function.
int32_t	getPriority () const
	retrieve the work item priority
AbstractServiceSharedPtr	getTargetService ()
	retrieve the service this work item is traveling to.
int32_t	getType () const
	retrieve the work item type identifier
int64_t	handle () const
	Returns the handle associated with the object.
bool	hasExecutor () const
	Does the object have custom executor.
bool	hasTimeout () const
	determines whether object defines a timeout
bool	invokeWithExecutor ()
	Dispatches the object with executor.
bool	runInWorkerThread () const
	Should this work item be run in worker thread or main thread.
void	setExecutor (ConnectWorkItem::Executor executorFunction)
	Setups an executor function to execute the work item.
void	setTargetService (AbstractServiceSharedPtr service)
	setups the target service
void	setTimeout (chrono::milliseconds timeout, int64_t handle)
	Sets the timeout for the work item.
chrono::milliseconds	timeoutUntilDeadline () const
	returns the timeout in milliseconds until this object time(s) out.
chrono::milliseconds	timeoutUntilDeadline (chrono::time_point< chrono::steady_clock > &now) const
	returns the timeout in milliseconds until this object time(s) out.
virtual	~ConnectWorkItem ()
	virtual destructor for cleanup.

Static Public Member Functions
static ConnectWorkItemSharedPtr	create (ExecutionContext executionContext=ExecutionContext::RUN_IN_MAIN_THREAD)
	Creates a default instance of the work item.

Protected Attributes
ExecutionContext	m_executionContext
	Defines whether work item should be executed in main thread or one of the workers.
Executor	m_executor
	Optional executor function that get(s) invoked to handle the item instead of passing it to the services handler function.
int32_t	m_priority
	Priority value.
AbstractServiceWeakPtr	m_service
	defines the service this work item is traveling to.
optional< TimerInfo >	m_timerInfo
	Optional object that defines the scheduling information.
int32_t	m_type
	Type identifier.

Detailed Description

Base class for work items that are passed through the workitem queue.

Member Typedef Documentation

Executor

typedef function<void(void)> kanzi::connect::ConnectWorkItem::Executor

Callback function that is dispatched to work queue and is used to execute work.

Member Enumeration Documentation

ExecutionContext

enum class kanzi::connect::ConnectWorkItem::ExecutionContext

strong

How to execute the work item.

Enumerator
RUN_IN_MAIN_THREAD
RUN_IN_WORKER_THREAD

Priority

enum kanzi::connect::ConnectWorkItem::Priority

Priority levels for the work items.

Enumerator
LowPriority	The lowest three are subject to fairness, that is, in certain situations lower priority items are processed even if Lowest priority for work items - gets processed last.
NormalPriority	Normal/Default priority for work items.
HighPriority	Highest priority for common work items. Gets processed first.
SystemPriority	Highest priority for work items. Gets processed first regardless of fairness.

Type

enum kanzi::connect::ConnectWorkItem::Type

Types for the work items.

Enumerator
Base	Base work item to be used for instances for ConnectWorkItem.
User	For user inherited work item classes, use identifier >= ID_USER.

Constructor & Destructor Documentation

ConnectWorkItem()

kanzi::connect::ConnectWorkItem::ConnectWorkItem	(	int32_t	type = Base,
		int32_t	priority = NormalPriority,
		ExecutionContext	executionContext = ExecutionContext::RUN_IN_MAIN_THREAD )

Constructor.

Parameters

type	Type of the work item.
priority	Priority of the work item.
executionContext	In which thread to execute the work item

~ConnectWorkItem()

virtual kanzi::connect::ConnectWorkItem::~ConnectWorkItem ( )

virtual

virtual destructor for cleanup.

Member Function Documentation

create()

static ConnectWorkItemSharedPtr kanzi::connect::ConnectWorkItem::create ( ExecutionContext executionContext = ExecutionContext::RUN_IN_MAIN_THREAD )

static

Creates a default instance of the work item.

Parameters

executionContext

Defines if the work item is to be run in main or worker thread

Returns

newly allocated instance.

deadlineIsEarlierThan()

bool kanzi::connect::ConnectWorkItem::deadlineIsEarlierThan

(

const ConnectWorkItem &

workItem

)

const

Checks whether this object(s) deadline is earlier than with the "other" item.

Parameters

workItem

the other time

Returns

true if this object triggers earlier than the other item.

getExecutor()

ConnectWorkItem::Executor kanzi::connect::ConnectWorkItem::getExecutor

(

)

const

Retrieve the executor function.

Returns

executor to handle the call.

getPriority()

int32_t kanzi::connect::ConnectWorkItem::getPriority

(

)

const

retrieve the work item priority

Returns

numeric priority value.

getTargetService()

AbstractServiceSharedPtr kanzi::connect::ConnectWorkItem::getTargetService

(

)

retrieve the service this work item is traveling to.

Returns

service pointer.

getType()

int32_t kanzi::connect::ConnectWorkItem::getType

(

)

const

retrieve the work item type identifier

Returns

numeric identifier

handle()

int64_t kanzi::connect::ConnectWorkItem::handle

(

)

const

Returns the handle associated with the object.

Handle is available only with timed objects.

Returns

handle. 0 if not defined.

hasExecutor()

bool kanzi::connect::ConnectWorkItem::hasExecutor

(

)

const

Does the object have custom executor.

Returns

true if executor exists.

hasTimeout()

bool kanzi::connect::ConnectWorkItem::hasTimeout

(

)

const

determines whether object defines a timeout

Returns

true if timeout is defined.

invokeWithExecutor()

bool kanzi::connect::ConnectWorkItem::invokeWithExecutor

(

)

Dispatches the object with executor.

This function is single shot type and will clear the executor instance once complete.

Returns

true if executor was defined and got invoked.

runInWorkerThread()

bool kanzi::connect::ConnectWorkItem::runInWorkerThread

(

)

const

Should this work item be run in worker thread or main thread.

Returns

True if worker thread

setExecutor()

void kanzi::connect::ConnectWorkItem::setExecutor

(

ConnectWorkItem::Executor

executorFunction

)

Setups an executor function to execute the work item.

Function can be created with std::bind.

Parameters

executorFunction

function to be called when it is time to handle the functionality.

setTargetService()

void kanzi::connect::ConnectWorkItem::setTargetService

(

AbstractServiceSharedPtr

service

)

setups the target service

Parameters

service

setTimeout()

void kanzi::connect::ConnectWorkItem::setTimeout	(	chrono::milliseconds	timeout,
		int64_t	handle )

Sets the timeout for the work item.

Timeout means this object will delay first specified amount of milliseconds and will then be delivered.

Parameters

timeout	timeout in milliseconds to delay the delivery.
handle	unique handle that can be used to refer to object later on.

timeoutUntilDeadline() [1/2]

chrono::milliseconds kanzi::connect::ConnectWorkItem::timeoutUntilDeadline

(

)

const

returns the timeout in milliseconds until this object time(s) out.

Returns

the timeout in milliseconds.

timeoutUntilDeadline() [2/2]

chrono::milliseconds kanzi::connect::ConnectWorkItem::timeoutUntilDeadline

(

chrono::time_point< chrono::steady_clock > &

now

)

const

returns the timeout in milliseconds until this object time(s) out.

Parameters

now	current timestamp if any.

Returns

timeout in milliseconds.

Member Data Documentation

m_executionContext

ExecutionContext kanzi::connect::ConnectWorkItem::m_executionContext

protected

Defines whether work item should be executed in main thread or one of the workers.

m_executor

Executor kanzi::connect::ConnectWorkItem::m_executor

protected

Optional executor function that get(s) invoked to handle the item instead of passing it to the services handler function.

m_priority

int32_t kanzi::connect::ConnectWorkItem::m_priority

protected

Priority value.

m_service

AbstractServiceWeakPtr kanzi::connect::ConnectWorkItem::m_service

protected

defines the service this work item is traveling to.

m_timerInfo

optional<TimerInfo> kanzi::connect::ConnectWorkItem::m_timerInfo

protected

Optional object that defines the scheduling information.

m_type

int32_t kanzi::connect::ConnectWorkItem::m_type

protected

Type identifier.

---

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

• connect/connect_work_item.hpp