Action allowing to update an action on a distant machine. More...

#include <UpdateRemoteAction.h>

Inheritance diagram for ipsdk::core::UpdateRemoteAction:

Public Member Functions
	~UpdateRemoteAction ()
	Destructor.

BoolResult	init (const Guid &providerGuid, const Guid &requestGuid, const ActionPtr &pAction)
	object initialization method More...

BoolResult	initFailure (const Guid &providerGuid, const Guid &requestGuid, const std::string &msgError)
	object initialization method for failure case More...

BoolResult	initNoMore (const Guid &providerGuid, const Guid &requestGuid)
	object initialization method for no more pending actions More...

const Guid &	getProviderGuid () const
	retrieve provider guid has known on remote machine More...

const Guid &	getRequestGuid () const
	retrieve request guid has known on local machine More...

Public Member Functions inherited from ipsdk::core::BaseSimpleAction
virtual	~BaseSimpleAction ()=0
	Destructor.

bool	isComplexAction () const
	retrieve action main complexity flag

Public Member Functions inherited from ipsdk::core::BaseAction
virtual	~BaseAction ()=0
	Destructor.

bool	isInit () const
	retrieve object initialization flag

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

const ePriority &	getActionPriority () const
	get priority associated to action (default : ePriority::eP_Normal)

void	setActionPriority (const BasePriority &actionPriority)
	set priority associated to action More...

void	addCompletionCB (const ActionCompletionCB &completionCB)
	add a completion callback for execution completion notifications More...

ExecResult	run (const eSynchroType &synchroType=eSynchroType::eST_Default)
	launch execution More...

void	requestCancellation ()
	action execution cancellation request More...

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

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

ExecResult	getActionResult () const
	retrieve action execution result More...

double	getFullActionDuration () const
	retrieve elasped execution duration between call to run and termination More...

double	getExecutionActionDuration () const
	retrieve elasped execution duration for action (waits not taken into account) More...

BoolResult	clear ()
	clear of execution data More...

bool	hasSocketGuid () const
	check whether action has an associated socket guid

void	setSocketGuid (const Guid &socketGuid)
	set socket guid associated to action

const Guid &	getSocketGuid () const
	access to socket guid associated to action More...

Public Member Functions inherited from ipsdk::SerializationObjectWithGuid
const Guid &	getGuid () const
	retrieve object guid

	SerializationObjectWithGuid ()

virtual	~SerializationObjectWithGuid ()=0

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Public Member Functions inherited from ipsdk::BaseToolTip
virtual const std::string &	getObjectName () const =0
	retrieve object name

virtual const std::string &	getToolTip () const =0
	retrieve object tool tip

	BaseToolTip ()

virtual	~BaseToolTip ()=0

Protected Member Functions
	UpdateRemoteAction ()
	Constructor.

ExecResultDerived	runDerived ()
	internal run method overloaded in derived classes More...

BoolResult	globalCleanDerived ()
	method called to clean execution data in derived class before initialization or during call to clear More...

Protected Member Functions inherited from ipsdk::core::BaseSimpleAction
	BaseSimpleAction ()
	Constructor.

Protected Member Functions inherited from ipsdk::core::BaseAction
	BaseAction ()
	Constructor.

bool	isSynchronismForced () const
	retrieve flag indicating whether action should be executed synchronously More...

BoolResult	initBase (const BasePriority &defaultPriority=NormalPriority())
	base class initialization method This method should be called by derived class during their initialization. Derived class should call this method before any update of derived data More...

virtual BoolResult	cleanOnErrorDerived (const eCleanReason &cleanReason)
	method called to clean execution data after an error in derived class This method is called on three cases : More...

virtual void	requestCancellationdDerived ()
	action execution cancellation request in derived classes

void	notifyCompletion (const ExecResult &bCompletionResult)
	method used by derived classes to notify of execution completion after an assynchronous run in derived class More...

ExecResultDerived	toExecResultDerived (const ExecResult &execResult) const
	method allowing to transform an ExecResult to an ExecResultDerived

virtual BoolResult	syncInputDataDerived (const Guid &processingSocketGuid)
	method allowing to synchronize input data for object in derived class

virtual BoolResult	syncOutputDataDerived (const Guid &processingSocketGuid)
	method allowing to synchronize output data for object in derived class

virtual void	clearInputData ()
	method allowing to clear input data for object

virtual void	clearIntermediateData ()
	method allowing to clear intermediate data for object

virtual void	clearOutputData ()
	method allowing to clear output data for object More...

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Protected Attributes
Guid	_providerGuid
	provider guid has known on remote machine

Guid	_requestGuid
	request guid has known on local machine

eQueryActionResult	_queryActionResult
	action request success flag

std::string	_msgError
	error message in case of failure

ActionPtr	_pAction
	pointer to action to be updated

Protected Attributes inherited from ipsdk::SerializationObjectWithGuid
Guid	_guid
	guid associated to object

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Protected Types inherited from ipsdk::core::BaseAction
enum	eCleanReason { eCR_Failure, eCR_Exception, eCR_Cancellation }
	Enumerate describing clean reason. More...

enum	eExecutionResultDerived { eERD_Success, eERD_Failure, eERD_Canceled, eERD_Running }
	Enumerate describing execution status after call to runDerived. More...

typedef ProcessingResult< eExecutionResultDerived >	ExecResultDerived
	returned type for runDerived method

Detailed Description

Action allowing to update an action on a distant machine.

Author: E. Noirfalise

Date: 2013/12/20

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ init()

BoolResult ipsdk::core::UpdateRemoteAction::init	(	const Guid &	providerGuid,
		const Guid &	requestGuid,
		const ActionPtr &	pAction
	)

object initialization method

Returns: false in case of failure

◆ initFailure()

BoolResult ipsdk::core::UpdateRemoteAction::initFailure	(	const Guid &	providerGuid,
		const Guid &	requestGuid,
		const std::string &	msgError
	)

object initialization method for failure case

Returns: false in case of failure

◆ initNoMore()

BoolResult ipsdk::core::UpdateRemoteAction::initNoMore	(	const Guid &	providerGuid,
		const Guid &	requestGuid
	)

object initialization method for no more pending actions

Returns: false in case of failure

◆ getProviderGuid()

const Guid& ipsdk::core::UpdateRemoteAction::getProviderGuid ( ) const

retrieve provider guid has known on remote machine

Exceptions

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

◆ getRequestGuid()

const Guid& ipsdk::core::UpdateRemoteAction::getRequestGuid ( ) const

retrieve request guid has known on local machine

Exceptions

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

◆ runDerived()

ExecResultDerived ipsdk::core::UpdateRemoteAction::runDerived ( )

protectedvirtual

internal run method overloaded in derived classes

Returns: execution result

Implements ipsdk::core::BaseAction.

◆ globalCleanDerived()

BoolResult ipsdk::core::UpdateRemoteAction::globalCleanDerived ( )

protectedvirtual

method called to clean execution data in derived class before initialization or during call to clear

After this call object is left un-initialized

Returns: false in case of failure

Reimplemented from ipsdk::core::BaseAction.

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/Action/Instances/UpdateRemoteAction.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members