IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Classes | Typedefs | Enumerations | Functions
ipsdk::core Namespace Reference

Namespace agregating IPSDK core execution routines and classes. More...

Classes

class  AskForRemoteAction
 Action allowing to ask for a new action on a distant machine. More...
 
class  BaseAction
 Base class for library actions. More...
 
class  BaseActionProvider
 Base class for action providers. More...
 
class  BaseActionRequest
 Base class for action requests. More...
 
class  BaseComplexAction
 Base class for library complex actions. More...
 
class  BaseComputerInfo
 Base class for objects agregating computer informations. More...
 
class  BasePriority
 Base class for priority encapsulation. More...
 
class  BaseRequestOrigin
 Base class for request origin description. More...
 
class  BaseSimpleAction
 Base class for library simple actions. More...
 
class  ComputerInfoPool
 Singleton allowing to store local and remote informations about computers into processing pool. More...
 
class  DistributedProcessingPolicy
 Class allowing to describe distributed processing policy used on local machine. More...
 
class  HighPriority
 Class used to encapsulate high priority. More...
 
class  IPSDKCoreException
 Exception class for library IPSDKCore. More...
 
class  LibraryInitializer
 Singleton instance used to initialized IPSDK library features. More...
 
class  LibraryUserConfiguration
 User configuration for IPSDK library. More...
 
class  LocalActionRequest
 Class used for local action request encapsulation. More...
 
class  LocalComputerInfo
 
class  LocalConfiguration
 Class allowing to describe local computer processing configuration. More...
 
class  LocalNetworkDescription
 Class encapsulating network description for multi-machine processings has seen by local machine. More...
 
class  LocalProcessingPolicy
 Class allowing to describe processing policy for local machine. More...
 
class  LocalRequestOrigin
 Class used to represent local request origin. More...
 
class  LowPriority
 Class used to encapsulate low priority. More...
 
class  NetworkDescription
 Class encapsulating network description for multi-machine processings. More...
 
class  NormalPriority
 Class used to encapsulate normal priority. More...
 
class  PendingActionRequest
 Class used for pending action request encapsulation. More...
 
class  PendingActionRequestManager
 Singleton class allowing to store and manage pending action requests. More...
 
class  ProviderManager
 Class allowing to manager providers execution with respect to their priority. More...
 
class  RegisterComputerInfo
 Action allowing to register a remote computer information on local machine. More...
 
class  RegisterRemoteProvider
 Action allowing to register a remote action provider on local machine. More...
 
class  RemoteActionProvider
 Class allowing to provide actions from a remote machine. More...
 
class  RemoteActionRequest
 Class used for remote action request encapsulation. More...
 
class  RemoteComputerInfo
 
class  RemoteRequestOrigin
 Class used to represent remote request origin. More...
 
class  RequestRemoteCancellation
 Action allowing to request termination of a given provider on a remote machine. More...
 
class  SDKVersionInfo
 Class encapsulating sdk version informations. More...
 
class  SingleActionProvider
 Class allowing to provide a single action. More...
 
class  SocketsPool
 Singleton used for socket pool management. More...
 
class  SocketsPoolCB
 callback class, whose methods are automatically called each time an event associated to the attached SocketsPool occurs More...
 
class  ThreadManager
 Singleton class used to manage execution threads. More...
 
class  UpdatePendingAction
 Action allowing to update a pending action on a distant machine. More...
 
class  UpdateRemoteAction
 Action allowing to update an action on a distant machine. More...
 

Typedefs

typedef boost::shared_ptr< RemoteComputerInfoRemoteComputerInfoPtr
 shared pointer to remote computer informations
 
typedef boost::shared_ptr< const RemoteComputerInfoRemoteComputerInfoConstPtr
 shared pointer to const remote computer informations
 
typedef std::map< Guid, RemoteComputerInfoPtrRemoteComputerInfoMap
 
typedef ProcessingResult< eLibInitStatusLibInitResult
 initialization result for library
 
typedef std::set< tcpip::AddressAddressColl
 ordered collection of ip address
 
typedef std::map< tcpip::Address, AddressCollAddressHierarchy
 collection of ip address with masters as keys and slaves as values
 
typedef boost::shared_ptr< LocalNetworkDescriptionLocalNetworkDescriptionPtr
 shared pointer to local network description
 
typedef boost::shared_ptr< BaseActionActionPtr
 shared pointer to BaseAction
 
typedef boost::function1< void, const ActionPtr & > ActionCompletionCB
 function callback used to notify of action completion
 
typedef std::list< ActionCompletionCBActionCompletionCBColl
 collection of functions callback used to notify of action completion
 
typedef ProcessingResult< eQueryActionResultQueryResult
 result of an action query
 
typedef boost::shared_ptr< BaseActionProviderActionProviderPtr
 shared pointer to action provider
 
typedef std::map< Guid, ActionRequestPtrActionRequestColl
 collection of action requests
 
typedef boost::function1< void, const ActionProviderPtr & > ProviderCompletionCB
 function callback used to notify of action provider completion
 
typedef std::list< ProviderCompletionCBProviderCompletionCBColl
 collection of functions callback used to notify of action provider completion
 
typedef boost::shared_ptr< BaseActionRequestActionRequestPtr
 shared pointer for action requests
 
typedef boost::shared_ptr< PendingActionRequestPendingActionRequestPtr
 shared pointer to pending action request
 
typedef boost::function1< void, const ActionRequestPtr & > RequestCompletionCB
 function callback used to notify of action request completion
 
typedef std::list< RequestCompletionCBRequestCompletionCBColl
 collection of functions callback used to notify of action request completion
 
typedef ProcessingResult< eExecutionResultExecResult
 type used to retrieve an execution result
 
typedef boost::shared_ptr< boost::thread > ThreadPtr
 shared pointer to thread
 
typedef std::map< ipUInt32, ThreadPtrThreadColl
 collection of indexed threads
 
typedef std::map< Guid, ActionProviderPtrProviderMap
 collection of providers ordered by guid
 
typedef std::list< ActionProviderPtrProviderList
 collection of execution providers
 
typedef std::map< ePriority, ProviderListProviderPriorityColl
 collection of execution providers ordered by priority
 
typedef std::list< ActionRequestPtrActionColl
 collection of action requests
 
typedef boost::shared_ptr< ProviderManagerProviderManagerPtr
 shared pointer to provider manager
 

Enumerations

enum  eComputerInfoMessage {
  eComputerInfoNotInit, eComputerInfoPoolInitFailed, eComputerInfoPoolNotInit, eRemoteCantAddToPool,
  eRemoteCantRemoveFromPool, eSDKVersionInfoNotInit, eGpuNotInitializedWarn
}
 Enumerate describing messages. More...
 
enum  eLibraryInitializerMessage {
  eClear, eCommonConfigPath, eComputerInfoPoolInitFailed, eCreateLocalNetDescFailed,
  eDistributedPolicyFilePath, eInitFailed, eLicenseFilePath, eLicenseInitFailed,
  eLocalComputerType, eLocalPolicyFilePath, eLogCfgFileProcessed, eLogDirCreationFailed,
  eLogInitFailed, eMainLogPath, eNetworkDescFilePath, eNotInit,
  eReadDistributedProcessingPolicyFailed, eReadLocalProcessingPolicyFailed, eReadNetworkDescFileFailed, eStartInit,
  eStartTimeOut, eTemporaryDirCreationFailed, eTimeOutEndSuccess, eTimeOutEndWarn,
  eUserConfigDirCreationFailed, eUserConfigPath, eWriteDistributedProcessingPolicyFailed, eWriteLocalProcessingPolicyFailed,
  eWarnGpuInitFailed, eWarnCouldNotRemoveDiskImage, eTryToRemoveDiskImageUsedByOtherProcess
}
 Enumerate describing messages. More...
 
enum  eLibInitStatus { eLIS_Failed, eLIS_Warn, eLIS_Success }
 Enumerate describing library initialization status. More...
 
enum  eLibraryPathConfigMessage { eInvalidEnumValue }
 Enumerate describing messages. More...
 
enum  eLibPathConfigType {
  eLPCT_LogMain, eLPCT_UserConfiguration, eLPCT_CommonConfiguration, eLPCT_Temporary,
  eLPCT_ProductLogo, eLPCT_CompanyLogo
}
 Enumerate describing library path configuration type. More...
 
enum  eLocalConfigMessage {
  eCanGetLocalCpuDescription, eDistributedProcessingPolicyNotInit, eInvalidDistributedAllocationWakeUpTimeout, eInvalidMaxMemSzForAllLocalDistributedStrip,
  eInvalidMaxMemSzForRemoteStripRequest, eInvalidMaxMemSzPerThread, eInvalidMinMemSzPerThread, eInvalidNbMaxThreads,
  eLocalConfigurationNotInit, eLocalProcessingPolicyNotInit, eNullNbMaxThreads, eDiskImaegPathDoesNotExist,
  eDiskImagePathCreated, eCanNotCreateDiskImaegPath
}
 Enumerate describing messages. More...
 
enum  eLocalProcessorType {
  eLPT_ProcessingNone, eLPT_StandaloneWorkstation, eLPT_ConnectedWorkstation, eLPT_ProcessingNode,
  eLPT_ProcessingClient
}
 
enum  eNetworkConfigMessage {
  eAddressNotFound, eCanAddMasterAddress, eCanAddSlaveAddress, eInvalidAddressType,
  eLocalNetworkDescMultiAddress, eLocalNetworkDescNoAddress, eLocalNetworkDescNotInit, eMasterAddressNotFound,
  eNetworkDescriptionNotInit, eSlaveAddressNotFound
}
 Enumerate describing messages. More...
 
enum  eUserConfigMessage { eCantGetAppDir, eCantGetAppName, eUserConfigNotInit }
 Enumerate describing messages. More...
 
enum  eIPSDKCoreMessage
 Enumerate describing messages. More...
 
enum  eNetworkLogMessages {
  eNoLocalIPAddrInNetworkDesc, eSeveralLocalIPAddrInNetworkDesc, eSocketConnected, eSocketConnectionClosed,
  eSocketConnectionFailed, eSocketConnectionLost, eSocketConnectionRefused, eSocketConnectionRequested,
  eSocketDelivered, eSocketDeliveryFailed, eSocketListening, eSocketRead,
  eSocketReadNotATask, eSocketReadNullPtr, eSocketsPoolCBActionFailed, eSocketsPoolCBExpectedConnect,
  eSocketsPoolCBNotInit, eSocketsPoolCBRegisterInitFailed, eSocketsPoolCBTimeOut, eSocketsPoolCBUnExpectedConnect,
  eSocketsPoolNoLicense, eSocketsPoolNotInitialize
}
 Enumerate describing messages. More...
 
enum  eActionMessage {
  eBaseNotInit, eBaseCantSetPriority, eBaseCantAddCompletionCB, eBaseNoSocketGuid,
  eBaseCantRunBadStatus, eBaseCantCleanBadStatus, eBaseCantInitBadStatus, eBaseCantCheckCancellation,
  eBaseCantRunSyncNotRunning, eBaseCancelled, eBaseCantSerializeBadStatus, eBaseCompletionCBException,
  eBaseNoSuccessfulExecution, eBaseEnteringActionExecution, eBaseInvalidSynchroType, eBaseFailed,
  eBaseExecutionException, eBaseInitException, eBaseLeavingActionExecution, eBaseEnteringActionGlobalClean,
  eBaseGlobalCleanFailed, eBaseGlobalCleanException, eBaseEnteringActionCleanOnError, eBaseCleanOnErrorFailed,
  eBaseCleanOnErrorException, eBaseInvalidRunDerivedStatus, eBaseInvalidRunStatusValue, eBaseCantWaitBadStatus,
  eBaseCantNotifyCompletion, eBaseCantGetSynchoBadStatus, eBaseBadExecutionResultEnumValue
}
 Enumerate describing messages. More...
 
enum  eSynchroType { eST_Synchronous, eST_Asynchronous, eST_Default }
 Enumerate describing synchronization type for execution. More...
 
enum  eComplexActionMessage { eEnteringInitProcess, eInitProcessingFailed, eEnteringEndProcess, eEndProcessingFailed }
 Enumerate describing messages. More...
 
enum  eActionInstancesMessage {
  eAskForRemoteActionInvalidObjectType, eAskForRemoteActionNoProvider, eAskForRemoteActionNoSocket, eAskForRemoteActionRequestFailed,
  eAskForRemoteActionToolTipId, eAskForRemoteInvalidRequestType, eAskForRemoteNoMore, eAskForRemoteUpdateInitFailed,
  eRegisterComputerInfoNoSocket, eRegisterComputerInfoSDKVersionError, eRegisterComputerInfoToolTipId, eRegisterRemoteProviderInitFailed,
  eRegisterRemoteProviderNoSocket, eRegisterRemoteProviderToolTipId, eRequestRemoteCancellationNoProvider, eRequestRemoteCancellationToolTipId,
  eUpdatePendingActionFailed, eUpdatePendingActionNoRequest, eUpdatePendingActionNullRequest, eUpdatePendingActionToolTipId,
  eUpdateRemoteActionBadStatus, eUpdateRemoteActionInvalidRequestType, eUpdateRemoteActionNoProvider, eUpdateRemoteActionNoRequest,
  eUpdateRemoteActionNotInit, eUpdateRemoteActionNullPtr, eUpdateRemoteActionToolTipId
}
 Enumerate describing messages. More...
 
enum  eActionProviderMessage {
  eBaseCanGetRequestBadStatus, eBaseCantAddCompletionCB, eBaseCantAddRemoteProvider, eBaseCantNotifyCompletion,
  eBaseCantRegisterRemoteProvider, eBaseCantRegisterRemoteProviders, eBaseClearBadStatus, eBaseCompletionCBException,
  eBaseNoPending, eBaseNotInit, eBaseProviderExecutionNotComplete, eBaseProviderInitException,
  eBaseProviderNotifyInvalidGuid, eBaseProviderTerminationRequested, eBaseQueryCancelled, eBaseQueryDerivedFailed,
  eBaseRegisterRemoteProviderInitFailed, eBaseRemoteProviderAlreadyExists, eBaseRemoteProviderCancellationFailed, eBaseRemoteProviderDeliveryFailed,
  eBaseRetrieveNotInit, eBaseRetrieveNullPtr, eProviderRestartFailed, eQueryNextActionException,
  eRemoteProviderBadRequestOrigin, eRemoteProviderRequestInitFailed, eSingleProviderActionNotInit, eSingleProviderBadRequestOrigin,
  eSingleProviderNullPtr, eSingleProviderRequestAlreadyDone, eSingleProviderRequestInitFailed
}
 Enumerate describing messages. More...
 
enum  eQueryActionResult { eQAR_Success, eQAR_Failure, eQAR_NoMore }
 Enumerate describing result of an action query. More...
 
enum  eActionRequestMessage {
  eBaseCantAddCompletionCB, eBaseCantCleanBadStatus, eBaseCantInitBadStatus, eBaseCantNotifyCompletion,
  eBaseCantRunBadStatus, eBaseCantUpdateStatus, eBaseInitException, eBaseNotCompleted,
  eBaseNotInit, eLocalActionBadStatus, eLocalActionNotInit, eLocalActionNullPtr,
  ePendingCancelInitFailed, ePendingCantExecute, ePendingCantUpdate, ePendingConnectionLost,
  ePendingInitActionBadStatus, ePendingInitActionNotInit, ePendingInitActionNullPtr, ePendingNoSuccessExec,
  ePendingRequestAlreadyRegistred, ePendingRequestNullPtr, ePendingSendFailed, ePendingUpdateActionBadStatus,
  ePendingUpdateActionNotInit, ePendingUpdateInitFailed, ePendingUpdateRemoteInitFailed, eRemoteActionBadStatus,
  eRemoteActionNotInit, eRemoteActionNullPtr, eRemoteAskInitFailed, eRemoteCantUpdate,
  eRemoteConnectionLost, eRemoteSendFailed, eRemoteUpdateInitFailed, eRequestExecutionException
}
 Enumerate describing messages. More...
 
enum  eActionRequestType { eART_Local, eART_Remote, eART_Pending }
 Enumerate describing action request type. More...
 
enum  ePriority { eP_Low, eP_Normal, eP_High, eP_System }
 Enumerate describing priority. More...
 
enum  eProcessingMessage { eNotAMessage }
 Enumerate describing messages. More...
 
enum  eExecutionStatus { eES_NotStarted, eES_WaitingForExecution, eES_Running, eES_Completed }
 Enumerate describing an execution status. More...
 
enum  eExecutionResult { eER_Successful, eER_Failed, eER_Canceled }
 Enumerate describing an execution result. More...
 
enum  eRequestOriginMessage { eRequestOriginNotInit }
 Enumerate describing messages. More...
 
enum  eRequestOrigin { eRO_Local, eRO_Remote }
 Enumerate describing request origin. More...
 
enum  eThreadManagerMessage {
  eActionRequestExecutionFailed, eActionRequestRetrivalBadEnumValue, eActionRequestRetrivalFailed, eEnteringExecutionThread,
  eEnteringThreadManagerInit, eExecutionThreadName, eProviderAlreadyDeleted, eProviderAlreadyExists,
  eProviderManagerNotInit, eProviderManagerProviderNotInit, eProviderManagerProviderNullPtr, eTerminatingThreadManager,
  eThreadManagerNoLicense, eThreadManagerNotInit
}
 Enumerate describing messages. More...
 

Functions

IPSDKCORE_API bool isAvailable (const eInstructionSet &instructionSet)
 function allowing to check for instruction set availability on local processor
 
IPSDKCORE_API ipsdk::BoolResult activateGpuSupport ()
 Activates GPU support.
 
IPSDKCORE_API ipsdk::BoolResult deactivateGpuSupport ()
 Deactivates GPU support.
 
IPSDKCORE_API bool isGpuSupportActivated ()
 Returns true if the GPU support is activated.
 
IPSDKCORE_API const boost::filesystem::path & getLibraryPath (const eLibPathConfigType &libPathConfigType)
 function allowing to retrieve a library path configuration type More...
 
IPSDKCORE_API const LocalProcessingPolicygetLocalProcessingPolicyConst ()
 retrieve used local processing policy
 
IPSDKCORE_API LocalProcessingPolicygetLocalProcessingPolicy ()
 retrieve used local processing policy
 
IPSDKCORE_API ipsdk::BoolResult saveLocalProcessingPolicy ()
 save the local processing policy
 
IPSDKCORE_API ipsdk::BoolResult saveLocalProcessingPolicy (const boost::filesystem::path &dirPath)
 save the local processing policy in a specific directory
 
IPSDKCORE_API const DistributedProcessingPolicygetDistributedProcessingPolicy ()
 retrieve used distributed processing policy
 
IPSDKCORE_API ipUInt32 getNbMaxThreads ()
 retrieve maximum number of usable thread for processings on local computer
 
IPSDKCORE_API ipUInt64 getMaxMemSzPerThread ()
 retrieve maximum physical memory (RAM) used by each thread on local computer
 
IPSDKCORE_API ipUInt64 getMinMemSzPerThread ()
 retrieve minimum physical memory (RAM) used by each thread on local computer
 
IPSDKCORE_API const boost::filesystem::path & getAllocatedDiskImagePath ()
 return the path to the directory where the automatically disk images are created
 
IPSDKCORE_API void setNbMaxThreads (const ipUInt32 nbMaxThreads)
 modify the maximum number of usable thread for processings on local computer
 
IPSDKCORE_API void setMaxMemSzPerThread (const ipUInt64 maxMemSzPerThread)
 modify the maximum physical memory (RAM) used by each thread on local computer
 
IPSDKCORE_API void setMinMemSzPerThread (const ipUInt64 minMemSzPerThread)
 modify the minimum physical memory (RAM) used by each thread on local computer
 
IPSDKCORE_API void setAllocatedDiskImagePath (const boost::filesystem::path &dirPath)
 modify the path to the directory where the automatically disk images are created More...
 
IPSDKCORE_API ipUInt64 getMaxMemSzForAllLocalDistributedStrip ()
 retrieve maximum used physical memory (RAM) for sum of all locally stored distributed strip
 
IPSDKCORE_API ipUInt64 getMaxMemSzForRemoteStripRequest ()
 retrieve maximum used physical memory (RAM) for remote strip memory storage request
 
IPSDKCORE_API ipUInt64 getDistributedProcessingMemThreshold ()
 retrieve threshold used to trigger a distributed processing of data
 
IPSDKCORE_API ipUInt64 getMaxMemSzForDistributedProcessing ()
 retrieve maximum memory size for processed data on a given remote computer
 
IPSDKCORE_API ipUInt64 getConnectionsInitializationTimeOut ()
 retrieve library time out for network connections initialization
 
IPSDKCORE_API ipUInt64 getDistributedAllocationWakeUpTimeout ()
 retrieve time out (in microseconds) used to wake up waiting loop during distributed image allocation. During distributed image allocation we request memory allocation on remote computers and we wait for answers. If, for a reason or another, some computers are slow in reponding (ie with a duration greater to this timeout) allocation request loop will emit a new allocation request to computers which have already answered and then potentially allow them to handle more memory
 
IPSDKCORE_API ipUInt64 getDistributedAllocationFailureTimeout ()
 retrieve time out (in microseconds) used to determine a failure into waiting loop used for distributed image allocation. During distributed image allocation we request memory allocation on remote computers and we wait for answers. If, for a reason or another, computers are slow in reponding (ie with a duration greater to this timeout) allocation request loop will fail
 
IPSDKCORE_API const std::string & getIPSDKCoreLoggerName ()
 Recovery of logger name associated to library.
 
IPSDKCORE_API log4cplus::Logger & getIPSDKCoreLogger ()
 Recovery of logger associated to library.
 
IPSDKCORE_API const LogMessageManagergetIPSDKCoreLogMessageManager ()
 Recovery of message manager associated to library.
 

Detailed Description

Namespace agregating IPSDK core execution routines and classes.

Typedef Documentation

◆ RemoteComputerInfoMap

collection of remote computer informations identified by their socket guid

Enumeration Type Documentation

◆ eComputerInfoMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eComputerInfoNotInit 

Computer informations has not been initialized, can't access its data.

eComputerInfoPoolInitFailed 

Failed to initialize computer information pool : s.

Failed to initialize computer information pool from local processing policy file s and distributed processing policy file s
s.

eComputerInfoPoolNotInit 

Computer information pool has not been initialized, can't access its data.

eRemoteCantAddToPool 

Can't add remote computer information with socket guid s for computer s to computer pool, it already exists.

eRemoteCantRemoveFromPool 

Can't remove remote computer information with socket guid s from computer pool, it doesn't exists.

eSDKVersionInfoNotInit 

SDK version information has not been initialized, can't access its data.

eGpuNotInitializedWarn 

The Gpu can not be initialized, please check your hardware compatibility: s.

◆ eLibraryInitializerMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eClear 

Termination of IPSDK library.

eCommonConfigPath 

Common configuration directory path for library : s.

eComputerInfoPoolInitFailed 

Failed to initialize computer information pool : s.

Failed to initialize computer information pool from local processing policy file s and distributed processing policy file s
s.

eCreateLocalNetDescFailed 

Failed to create local network description object
s.

eDistributedPolicyFilePath 

Used distributed processing policy file path : s.

eInitFailed 

Failed to initialize library
s.

eLicenseFilePath 

Used license file path : s.

eLicenseInitFailed 

Failed to initialize library license manager for license file s
s.

eLocalComputerType 

Local computer processor type : s.

eLocalPolicyFilePath 

Used local processing policy file path : s.

eLogCfgFileProcessed 

Logger configuration file s found.

eLogDirCreationFailed 

Failed to create user log directory s
s.

eLogInitFailed 

Failed to initialize library log system
s.

eMainLogPath 

Main log file path for library : s.

eNetworkDescFilePath 

Used network description file path : s.

eNotInit 

IPSDK library initializer not initialized, can't access its data.

eReadDistributedProcessingPolicyFailed 

Failed to read distributed processing policy from file s
s.

eReadLocalProcessingPolicyFailed 

Failed to read local processing policy from file s
s.

eReadNetworkDescFileFailed 

Failed to read network description from file s
s.

eStartInit 

Starting IPSDK library initialization...

eStartTimeOut 

Starting connections timeout for d milliseconds...

eTemporaryDirCreationFailed 

Failed to create temporary directory s
s.

eTimeOutEndSuccess 

All connections successfull.

eTimeOutEndWarn 

Connections timeout ended, connections are still pending.

eUserConfigDirCreationFailed 

Failed to create user configuration directory s
s.

eUserConfigPath 

User configuration directory path for library : s.

eWriteDistributedProcessingPolicyFailed 

Failed to write default distributed processing policy to file s
s.

eWriteLocalProcessingPolicyFailed 

Failed to write default local processing policy to file s
s.

eWarnGpuInitFailed 

Failed to initialize the GPU : s. check your driver version.

eWarnCouldNotRemoveDiskImage 

Could not remove disk image : s.

eTryToRemoveDiskImageUsedByOtherProcess 

Could not remove disk image s:
s.

◆ eLibInitStatus

Enumerate describing library initialization status.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eLIS_Failed 

library initialization has failed, can't use library

eLIS_Warn 

library initialization has been successfully processed with warnings

eLIS_Success 

library initialization has been successfully processed

◆ eLibraryPathConfigMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eInvalidEnumValue 

Invalid library path configuration type enumerate value s.

◆ eLibPathConfigType

Enumerate describing library path configuration type.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eLPCT_LogMain 

library log main directory

eLPCT_UserConfiguration 

library user configuration directory

eLPCT_CommonConfiguration 

common (all users) configuration directory

eLPCT_Temporary 

library temporary directory

eLPCT_ProductLogo 

product logo file path

eLPCT_CompanyLogo 

company logo file path

◆ eLocalConfigMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eCanGetLocalCpuDescription 

Can't retrieve local cpu description
s.

eDistributedProcessingPolicyNotInit 

Distributed processing configuration has not been initialized, can't access its data.

eInvalidDistributedAllocationWakeUpTimeout 

Invalid value for distributed allocation wake up timeout lld, should be lower than distributed allocation failure timeout lld.

eInvalidMaxMemSzForAllLocalDistributedStrip 

Provided maximum memory size for all local distributed strip (lld bytes) exceeds total available physical memory size (lld bytes), defaulting to half total available physical memory size.

eInvalidMaxMemSzForRemoteStripRequest 

Provided maximum memory size for a single distributed allocation (lld bytes) exceeds maximum memory size for all local distributed strip (lld bytes), defaulting to quater of maximum memory size for all local distributed strip.

eInvalidMaxMemSzPerThread 

Provided maximum memory size per thread for processings on local computer (d bytes) exceeds total available physical memory size (lld bytes) divided by maximum number of usable threads (lld)

eInvalidMinMemSzPerThread 

Invalid minimum memory size per thread (lld bytes), should be lower than maximum (lld bytes)

eInvalidNbMaxThreads 

Provided maximum number of usable thread for processings on local computer d is greater than available logical cores, updating value with number of available logical cores d.

eLocalConfigurationNotInit 

Local processing configuration has not been initialized, can't access its data.

eLocalProcessingPolicyNotInit 

Local processing policy has not been initialized, can't access its data.

eNullNbMaxThreads 

Provided maximum number of usable thread for processings on local computer should not be null, updating value with number of available physical cores d.

eDiskImaegPathDoesNotExist 

The directory s does not exist. Attempting to create it...

eDiskImagePathCreated 

The directory s has been created.

eCanNotCreateDiskImaegPath 

Could not create the directory s: s.

◆ eLocalProcessorType

Enumerator
eLPT_ProcessingNone 

computer has no processing capabilities

eLPT_StandaloneWorkstation 

computer is a standalone local processing client and server (without network processing capabilities)

eLPT_ConnectedWorkstation 

computer is a processing client and server with network processing capabilities

eLPT_ProcessingNode 

computer is a processing server (with network processing capabilities and without client processing capabilities)

eLPT_ProcessingClient 

computer is a processing client (with network processing capabilities and without local processing capabilities)

◆ eNetworkConfigMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eAddressNotFound 

Tcpip address s has not been found into network description.

eCanAddMasterAddress 

Can't add master address s, it already exists in network description collection.

eCanAddSlaveAddress 

Can't add slave address s, it already exists in network description collection.

eInvalidAddressType 

Network description address type s and provided address s type mismatch.

eLocalNetworkDescMultiAddress 

Multiple ip addresses have been found in network description for local machine : can be s or s.

eLocalNetworkDescNoAddress 

No ip address found in network description for local machine.

eLocalNetworkDescNotInit 

Local network description has not been initialized, can't access its data.

eMasterAddressNotFound 

Can't find master address s.

eNetworkDescriptionNotInit 

Network description has not been initialized, can't access its data.

eSlaveAddressNotFound 

Can't find slave address s.

◆ eUserConfigMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eCantGetAppDir 

Can't retrieve application directory.

eCantGetAppName 

Can't retrieve application name.

eUserConfigNotInit 

Library user configuration has not been initialized, can't access its data.

◆ eIPSDKCoreMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map

◆ eNetworkLogMessages

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eNoLocalIPAddrInNetworkDesc 

local ip address does not appear in network description

eSeveralLocalIPAddrInNetworkDesc 

local ip address appears more than once in network description

eSocketConnected 

socket connection established; socket guid=s, local=s, remote=s

eSocketConnectionClosed 

socket connection closed; socket guid=s

eSocketConnectionFailed 

socket connection failed; socket guid=s, remote=s, error=s

eSocketConnectionLost 

socket connection lost; socket guid=s, local=s, remote=s, error=s

eSocketConnectionRefused 

socket connection refused; listen port #d, error=s

eSocketConnectionRequested 

Socket connection requested on address s and port d.

eSocketDelivered 

socket delivered; socket guid=s, local=s, remote=s, delivery id=d

eSocketDeliveryFailed 

socket delivery failed; socket guid=s, deliveryId=d

eSocketListening 

Socket start listening on port d.

eSocketRead 

socket obj read; socket guid=s, local=s, remote=s, obj classname=s

eSocketReadNotATask 

socket obj read; socket obj is not a task (classname=s); socket guid=s; is that ok?

eSocketReadNullPtr 

Input read shared pointer is null, can't process task.

eSocketsPoolCBActionFailed 

Execution of action s failed
s.

eSocketsPoolCBExpectedConnect 

Remote computer information registration action successfull for expected ip address s.

eSocketsPoolCBNotInit 

Sockets pool callback has been initialized.

eSocketsPoolCBRegisterInitFailed 

Initialization of action RegisterComputerInfo failed
s.

eSocketsPoolCBTimeOut 

Library initialization socket call back has reach time out deadline with following pending connections : s.

eSocketsPoolCBUnExpectedConnect 

Remote computer information registration action successfull for un expected ip address s.

eSocketsPoolNoLicense 

Remote processing license feature is not available, can't initialize socket pool connections.

eSocketsPoolNotInitialize 

please call SocketPools::init before

◆ eActionMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eBaseNotInit 

Action s has not been initialized.

Action request has not been initialized, can't access its data.

Action provider has not been initialized.

eBaseCantSetPriority 

Can't set priority on action s while status is different of not started.

eBaseCantAddCompletionCB 

Can't add completion callback on action s while status is different of not started.

Can't add completion callback on action request while status is different of not started.

Can't add completion callback on action provider while status is different of not started.

eBaseNoSocketGuid 

Action s has no associated socket guid, can't get it.

eBaseCantRunBadStatus 

Can't run action s, while status [s] is different of not started.

Can't run action request while status is different of not started.

eBaseCantCleanBadStatus 

Can't clean action s, while status is running.

Can't clean action request while status is running.

eBaseCantInitBadStatus 

Can't initialize action s, while status is running.

Can't initialize action request while status is running.

eBaseCantCheckCancellation 

Can't check cancellation for action s, while status is not running.

eBaseCantRunSyncNotRunning 

Can't call syncRun on action s while status is not running.

eBaseCancelled 

Action s has been cancelled.

eBaseCantSerializeBadStatus 

Can't serialize action s, while status is running.

eBaseCompletionCBException 

An exception has been thrown while processing action completion callback for action s
s.

An exception has been thrown while processing provider completion callback for provider with guid s
s.

eBaseNoSuccessfulExecution 

No successful execution for s, can't get results.

eBaseEnteringActionExecution 

Entering execution of s.

eBaseInvalidSynchroType 

Invalid synchronisation enumerate value s.

eBaseFailed 

Execution of s failed
s.

eBaseExecutionException 

Exception thrown during execution of s
s.

eBaseInitException 

Exception thrown during initialization of s
s.

Exception thrown during initialization of action request
s.

eBaseLeavingActionExecution 

Leaving execution of s.

eBaseEnteringActionGlobalClean 

Entering global cleaning for s.

eBaseGlobalCleanFailed 

Global cleaning of s failed
s.

eBaseGlobalCleanException 

Exception thrown during global cleaning of s
s.

eBaseEnteringActionCleanOnError 

Entering cleaning of s after s.

eBaseCleanOnErrorFailed 

Clean on error of s failed
s.

eBaseCleanOnErrorException 

Exception thrown during clean on error of s
s.

eBaseInvalidRunDerivedStatus 

Invalid returned status eExecStatus::eES_Running for runDerived method while forcing synchronous execution of s.

eBaseInvalidRunStatusValue 

Invalid enumerate value for execution status s.

eBaseCantWaitBadStatus 

Can't wait for action completion for s while status is not started.

eBaseCantNotifyCompletion 

Can't notify for action completion while status is not running for action s.

Can't notify for action request completion while status is not running.

Can't notify request completion while action provider status is not running.

eBaseCantGetSynchoBadStatus 

Can't get synchronisation flag for s while status is not running.

eBaseBadExecutionResultEnumValue 

Execution result enumerate value s is invalid.

◆ eSynchroType

Enumerate describing synchronization type for execution.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eST_Synchronous 

Focus is returned to caller after execution termination.

Synchronous execution.

eST_Asynchronous 

Asynchronous execution. Focus is immediately returned to caller. A call to waitForTermination must be done to ensure execution termination

eST_Default 

Synchronism of execution will be defined by object prefered state.

◆ eComplexActionMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eEnteringInitProcess 

Entering initialization of processing for s.

eInitProcessingFailed 

Initialization of processing failed for s
s.

eEnteringEndProcess 

Entering ending of processing for s.

eEndProcessingFailed 

End of processing failed for s
s.

◆ eActionInstancesMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eAskForRemoteActionInvalidObjectType 

Invalid retrieved object type s while waiting for Provider associated to guid s.

eAskForRemoteActionNoProvider 

Failed to retrieve provider associated to guid s for remote action request.

eAskForRemoteActionNoSocket 

Ask for remote action action has no associated socket guid, can't process action.

eAskForRemoteActionRequestFailed 

Action request failed while asking provider associated to guid s
s.

eAskForRemoteActionToolTipId 

Action allowing to ask for a new processing action on a distant machine.

eAskForRemoteInvalidRequestType 

Invalid retrieve request type s while looking for a PendingActionRequest while executing ask for remote action.

eAskForRemoteNoMore 

No more action to execute for remote action request associated to provider with guid s.

eAskForRemoteUpdateInitFailed 

Failed to initialize UpdateRemoteAction
s.

eRegisterComputerInfoNoSocket 

Register computer information action has no associated socket guid, can't process action.

eRegisterComputerInfoSDKVersionError 

Register computer information action repport a mismatch between sdk versions : local host version d.d.d.d, remote host version d.d.d.d [with socket Guid : s].

eRegisterComputerInfoToolTipId 

Action allowing to register a remote computer information on local machine.

eRegisterRemoteProviderInitFailed 

Register remote action provider action failed to initialize remote provider
s.

eRegisterRemoteProviderNoSocket 

Register remote action provider action has no associated socket guid, can't process action.

eRegisterRemoteProviderToolTipId 

Action allowing to register a remote action provider on local machine.

eRequestRemoteCancellationNoProvider 

Failed to retrieve provider associated to guid s for remote cancellation request.

eRequestRemoteCancellationToolTipId 

Action allowing to request termination of a given provider on a remote machine.

eUpdatePendingActionFailed 

Pending request action update notification failed
s.

eUpdatePendingActionNoRequest 

Failed to retrieve request associated to guid s for update pending action request.

eUpdatePendingActionNullRequest 

Request pointer associated to update pending action should not be null.

eUpdatePendingActionToolTipId 

Action allowing to update a pending action on a distant machine.

eUpdateRemoteActionBadStatus 

Can't init UpdateRemoteAction with an action for which status is different of not started.

eUpdateRemoteActionInvalidRequestType 

Invalid retrieve request type s while looking for a RemoteActionRequest while executing update remote action request.

eUpdateRemoteActionNoProvider 

Failed to retrieve provider associated to guid s for update remote action request.

eUpdateRemoteActionNoRequest 

Failed to retrieve request associated to guid s and provider guid s for update remote action request.

eUpdateRemoteActionNotInit 

Can't init UpdateRemoteAction with an unitialized action.

eUpdateRemoteActionNullPtr 

Can't init UpdateRemoteAction with a null action pointer.

eUpdateRemoteActionToolTipId 

Action allowing to update an action on a distant machine.

◆ eActionProviderMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eBaseCanGetRequestBadStatus 

Can't get request associated to action provider while status is not started.

eBaseCantAddCompletionCB 

Can't add completion callback on action s while status is different of not started.

Can't add completion callback on action request while status is different of not started.

Can't add completion callback on action provider while status is different of not started.

eBaseCantAddRemoteProvider 

Can't add remote provider on action provider while status is completed.

eBaseCantNotifyCompletion 

Can't notify for action completion while status is not running for action s.

Can't notify for action request completion while status is not running.

Can't notify request completion while action provider status is not running.

eBaseCantRegisterRemoteProvider 

Can't instantly register a new remote provider while action provider status is not running.

eBaseCantRegisterRemoteProviders 

Can't register remote providers on action provider while status is completed.

eBaseClearBadStatus 

Can't clear action provider while status is running.

eBaseCompletionCBException 

An exception has been thrown while processing action completion callback for action s
s.

An exception has been thrown while processing provider completion callback for provider with guid s
s.

eBaseNoPending 

Action provider has no more pending actions.

eBaseNotInit 

Action s has not been initialized.

Action request has not been initialized, can't access its data.

Action provider has not been initialized.

eBaseProviderExecutionNotComplete 

Action provider execution is not terminated, can't get execution results.

eBaseProviderInitException 

Exception thrown during initialization of action provider
s.

eBaseProviderNotifyInvalidGuid 

Invalid action request guid s while notifiying action provider for action completion.

eBaseProviderTerminationRequested 

Action provider termination has been requested.

eBaseQueryCancelled 

Action provider query for new action request failed due to a cancellation request.

eBaseQueryDerivedFailed 

Action provider query for new action request failed in derived class
s.

eBaseRegisterRemoteProviderInitFailed 

Failed to initialize register remote provider action for socket guid s
s.

eBaseRemoteProviderAlreadyExists 

Can't register remote provider for socket guid s, it already exists.

eBaseRemoteProviderCancellationFailed 

Failed to initialize remote provider cancellation action for socketGuid s
s.

eBaseRemoteProviderDeliveryFailed 

Failed to send registration request for remote provider associated to socket guid s.

eBaseRetrieveNotInit 

Retrieved action request should be initialized when returned by derived class.

eBaseRetrieveNullPtr 

Retrieved action request pointer should not be null when returned by derived class.

eProviderRestartFailed 

Failed to restart provider with guid s, provider has not been found into ThreadManager collection
s.

eQueryNextActionException 

An exception has been thrown during query of next action
s.

eRemoteProviderBadRequestOrigin 

Action requests should only be issued by local thread manager for remote provider.

eRemoteProviderRequestInitFailed 

Failed to initialize remote request in remote action provider with guid s and for socket guid s
s.

eSingleProviderActionNotInit 

Action should be initialized while initializing single action provider.

eSingleProviderBadRequestOrigin 

Action requests should only be issued by local thread manager for single provider.

eSingleProviderNullPtr 

Action pointer should not be null while initializing single action provider.

eSingleProviderRequestAlreadyDone 

Single provider request has already provide its action for execution.

eSingleProviderRequestInitFailed 

Failed to initialize local request in local action provider
s.

◆ eQueryActionResult

Enumerate describing result of an action query.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eQAR_Success 

Action query is successfull.

eQAR_Failure 

Action query has failed.

eQAR_NoMore 

No more action can be queried, all actions have already been queried.

◆ eActionRequestMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eBaseCantAddCompletionCB 

Can't add completion callback on action s while status is different of not started.

Can't add completion callback on action request while status is different of not started.

Can't add completion callback on action provider while status is different of not started.

eBaseCantCleanBadStatus 

Can't clean action s, while status is running.

Can't clean action request while status is running.

eBaseCantInitBadStatus 

Can't initialize action s, while status is running.

Can't initialize action request while status is running.

eBaseCantNotifyCompletion 

Can't notify for action completion while status is not running for action s.

Can't notify for action request completion while status is not running.

Can't notify request completion while action provider status is not running.

eBaseCantRunBadStatus 

Can't run action s, while status [s] is different of not started.

Can't run action request while status is different of not started.

eBaseCantUpdateStatus 

Can't update action request status while status is different of not started.

eBaseInitException 

Exception thrown during initialization of s
s.

Exception thrown during initialization of action request
s.

eBaseNotCompleted 

Action request has not been completed, can't get results.

eBaseNotInit 

Action s has not been initialized.

Action request has not been initialized, can't access its data.

Action provider has not been initialized.

eLocalActionBadStatus 

Can't initialize local action request with an action for which status is different of not started.

eLocalActionNotInit 

Can't initialize local action request with an unitialized action.

eLocalActionNullPtr 

Can't initialize local action request with a null action pointer.

ePendingCancelInitFailed 

Initialization of remote cancellation action failed while executing pending action
s.

ePendingCantExecute 

PendingActionRequest::ExecuteActionDerived method should never be called.

ePendingCantUpdate 

Can't update action of pending action request while status is different of waiting for execution.

ePendingConnectionLost 

Connection has been lost during pending request execution.

ePendingInitActionBadStatus 

Can't initialize action of pending action request with an action for which status is different of not started.

ePendingInitActionNotInit 

Can't initialize action of pending action request with an unitialized action.

ePendingInitActionNullPtr 

Can't initialize action of pending action request with a null action pointer.

ePendingNoSuccessExec 

No successful execution for pending request, can't get associated action.

ePendingRequestAlreadyRegistred 

Pending action request with guid s has already been registed.

ePendingRequestNullPtr 

Input pending action request shared pointer should not be null.

ePendingSendFailed 

Update remote action send failed while trying to update remote action on socket s.

ePendingUpdateActionBadStatus 

Can't update action of pending action request with an action for which status is different of completed.

ePendingUpdateActionNotInit 

Can't update action of pending action request with an unitialized action.

ePendingUpdateInitFailed 

Initialization of update remote action failed while executing pending action initialization
s.

ePendingUpdateRemoteInitFailed 

Failed to initialize update remote action object
s.

eRemoteActionBadStatus 

Can't update action of remote action request with an action for which status is different of not started.

eRemoteActionNotInit 

Can't update action of remote action request with an unitialized action.

eRemoteActionNullPtr 

Can't update action of remote action request with a null action pointer.

eRemoteAskInitFailed 

Initialization of ask for remote action failed while executing remote action request
s.

eRemoteCantUpdate 

Can't update action of remote action request while status is not running.

eRemoteConnectionLost 

Connection lost while trying to retrieve remote action on socket s.

eRemoteSendFailed 

Ask for remote action send failed while trying to retrieve remote action on socket s.

eRemoteUpdateInitFailed 

Initialization of update pending action failed while executing remote action request
s.

eRequestExecutionException 

An exception has been thrown while executing action request
s.

◆ eActionRequestType

Enumerate describing action request type.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eART_Local 

Action request is local, associated action can be immediatly accessed.

eART_Remote 

Action request is remote, associated action access may be delayed.

eART_Pending 

Action request issued from local machine, sent to distant and waiting for completion.

◆ ePriority

Enumerate describing priority.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eP_Low 

Action will be executed with a low priority.

eP_Normal 

Action will be executed with normal priority.

eP_High 

Action will be executed with a high priority.

eP_System 

Action will be executer with a system priority

◆ eProcessingMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map

◆ eExecutionStatus

Enumerate describing an execution status.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eES_NotStarted 

Object is ready for execution.

eES_WaitingForExecution 

Object is waiting for execution.

eES_Running 

Object is running execution.

eES_Completed 

Object execution has completed.

◆ eExecutionResult

Enumerate describing an execution result.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eER_Successful 

Execution is successful.

eER_Failed 

Execution has failed.

eER_Canceled 

Execution has been canceled.

◆ eRequestOriginMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eRequestOriginNotInit 

Request origin has not been initialized, can't access its data.

◆ eRequestOrigin

Enumerate describing request origin.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eRO_Local 

Request issue from local machine.

eRO_Remote 

Request issue from remote machine.

◆ eThreadManagerMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eActionRequestExecutionFailed 

Action request execution failed
s.

eActionRequestRetrivalBadEnumValue 

Bad enumerate return value s for retrieve requested action.

eActionRequestRetrivalFailed 

Failed to retrieve requested action
s.

eEnteringExecutionThread 

Entering execution thread s.

eEnteringThreadManagerInit 

Entering execution thread manager initialization.

eExecutionThreadName 

IPSDKActionThread_d.

eProviderAlreadyDeleted 

Provider with Guid s has already been deleted from thread manager collection before completion notification.

eProviderAlreadyExists 

Provider with Guid s already exists for thread manager.

eProviderManagerNotInit 

Provider manager has not been initialized.

eProviderManagerProviderNotInit 

Action provider should be initialized for registration.

eProviderManagerProviderNullPtr 

Action provider shared pointer should not be null for registration.

eTerminatingThreadManager 

Thread manager is terminating.

eThreadManagerNoLicense 

No processing license available, can't register action provider.

eThreadManagerNotInit 

Execution thread manager has not been initialized.

Function Documentation

◆ getLibraryPath()

IPSDKCORE_API const boost::filesystem::path& ipsdk::core::getLibraryPath ( const eLibPathConfigType libPathConfigType)

function allowing to retrieve a library path configuration type

Exceptions
ipsdk::core::IPSDKCoreExceptionif ComputerInfoPool::getInstance().isInit() == false

◆ setAllocatedDiskImagePath()

IPSDKCORE_API void ipsdk::core::setAllocatedDiskImagePath ( const boost::filesystem::path &  dirPath)

modify the path to the directory where the automatically disk images are created

Exceptions
ipsdk::core::IPSDKCoreExceptionif ComputerInfoPool::getInstance().isInit() == false