Class allowing to provide a single action. More...

#include <SingleActionProvider.h>

Inheritance diagram for ipsdk::core::SingleActionProvider:

Public Member Functions
BoolResult	init (const ActionPtr &pAction)
	object initialization method More...

const BaseAction &	getAction () const
	retrieve action associated to object More...

Constructors and destructors
	SingleActionProvider ()

	~SingleActionProvider ()

Public Member Functions inherited from ipsdk::core::BaseActionProvider
bool	isInit () const
	retrieve object initialization flag

const Guid &	getGuid () const
	retrieve guid associated to provider More...

const ePriority &	getActionsPriority () const
	retrieve priority associated to provided actions More...

eExecutionStatus	getStatus () const
	check for provider execution status More...

void	addCompletionCB (const ProviderCompletionCB &completionCB)
	add a completion callback associated to action provider More...

bool	areActionsPending () const
	check whether additional actions potentially are pending More...

void	waitForCompletion ()
	method allowing to wait for execution completion More...

bool	waitForCompletion (const boost::chrono::milliseconds &duration)
	method allowing to wait for a given duration for execution completion More...

bool	waitForCompletion (const boost::chrono::system_clock::time_point &deadLineTime)
	method allowing to wait until a given time point for execution completion More...

void	requestCancellation ()
	method allowing to request cancellation More...

bool	isCancellationRequested () const
	check whether a cancellation has been requested More...

ExecResult	getGlobalResult () const
	retrieve execution global result More...

double	getFullExecutionDuration () const
	retrieve full execution time More...

void	clear ()
	clear of object data More...

	BaseActionProvider ()

virtual	~BaseActionProvider ()=0

Protected Member Functions
QueryResult	queryNextAction (const BaseRequestOrigin &requestOrigin, ActionRequestPtr &pActionRequest, bool &bProcessCompletionCheck, SerializationObjectPtr &pCbAdditionalData)
	query for next action to be processed in derived class More...

bool	hasPendingAction () const
	method allowing to check whether actions are pending in derived class

void	clearDerived ()
	clear of data in derived class

Protected Member Functions inherited from ipsdk::core::BaseActionProvider
BoolResult	initBase (const BasePriority &actionsPriority, const Guid &providerGuid=Guid())
	base class initialization method More...

bool	existsRemoteProvider (const Guid &socketGuid)
	check whether a remote provider exists for a given socket guid More...

void	addRemoteProvider (const Guid &socketGuid)
	define a new remote provider for a given socket guid More...

bool	unRegisterRemoteProvider (const Guid &socketGuid)
	un register a remote provider for a given socket guid More...

BoolResult	registerRemoteProvider (const Guid &socketGuid)
	instantly register a new remote provider for a given socket guid More...

BoolResult	registerRemoteProviders ()
	register remote providers associated to object More...

virtual BoolResult	notifyDerived (const ActionRequestPtr &pActionRequest, const SerializationObjectConstPtr &pCbAdditionalData, bool &bRestartProvider)
	method used to notify of execution completion for a given request More...

virtual void	requestCancellationDerived ()
	method allowing to request cancellation in derived classes

Protected Attributes
ActionPtr	_pAction
	single action associated to provider

bool	_bDispatched
	flag indicating whether action has already been retrieved

Detailed Description

Class allowing to provide a single action.

Author: E. Noirfalise

Date: 2013/12/18

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ init()

BoolResult ipsdk::core::SingleActionProvider::init ( const ActionPtr & pAction )

object initialization method

Exceptions

ipsdk::core::IPSDKCoreException	if pAction.get() == 0
ipsdk::core::IPSDKCoreException	if pAction->isInit() == false

Returns: false in case of failure

◆ getAction()

const BaseAction& ipsdk::core::SingleActionProvider::getAction ( ) const

retrieve action associated to object

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ queryNextAction()

QueryResult ipsdk::core::SingleActionProvider::queryNextAction	(	const BaseRequestOrigin &	requestOrigin,
		ActionRequestPtr &	pActionRequest,
		bool &	bProcessCompletionCheck,
		SerializationObjectPtr &	pCbAdditionalData
	)

protectedvirtual

query for next action to be processed in derived class

Note: this method is protected against concurrent accesses

Returns: query result. Returned action request must not be null nor uninitialized

Exceptions

ipsdk::core::IPSDKCoreException if requestOrigin.getRequestOrigin() != eRequestOrigin::eRO_Local

Implements ipsdk::core::BaseActionProvider.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKCore/Processing/ActionProvider/Instances/SingleActionProvider.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ init()

◆ getAction()

◆ queryNextAction()