![]() |
IPSDK
4_1_0_2
IPSDK : Image Processing Software Development Kit
|
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< RemoteComputerInfo > | RemoteComputerInfoPtr |
| shared pointer to remote computer informations | |
| typedef boost::shared_ptr< const RemoteComputerInfo > | RemoteComputerInfoConstPtr |
| shared pointer to const remote computer informations | |
| typedef std::map< Guid, RemoteComputerInfoPtr > | RemoteComputerInfoMap |
| typedef ProcessingResult< eLibInitStatus > | LibInitResult |
| initialization result for library | |
| typedef std::set< tcpip::Address > | AddressColl |
| ordered collection of ip address | |
| typedef std::map< tcpip::Address, AddressColl > | AddressHierarchy |
| collection of ip address with masters as keys and slaves as values | |
| typedef boost::shared_ptr< LocalNetworkDescription > | LocalNetworkDescriptionPtr |
| shared pointer to local network description | |
| typedef boost::shared_ptr< BaseAction > | ActionPtr |
| shared pointer to BaseAction | |
| typedef boost::function1< void, const ActionPtr & > | ActionCompletionCB |
| function callback used to notify of action completion | |
| typedef std::list< ActionCompletionCB > | ActionCompletionCBColl |
| collection of functions callback used to notify of action completion | |
| typedef ProcessingResult< eQueryActionResult > | QueryResult |
| result of an action query | |
| typedef boost::shared_ptr< BaseActionProvider > | ActionProviderPtr |
| shared pointer to action provider | |
| typedef std::map< Guid, ActionRequestPtr > | ActionRequestColl |
| collection of action requests | |
| typedef boost::function1< void, const ActionProviderPtr & > | ProviderCompletionCB |
| function callback used to notify of action provider completion | |
| typedef std::list< ProviderCompletionCB > | ProviderCompletionCBColl |
| collection of functions callback used to notify of action provider completion | |
| typedef boost::shared_ptr< BaseActionRequest > | ActionRequestPtr |
| shared pointer for action requests | |
| typedef boost::shared_ptr< PendingActionRequest > | PendingActionRequestPtr |
| 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< RequestCompletionCB > | RequestCompletionCBColl |
| collection of functions callback used to notify of action request completion | |
| typedef ProcessingResult< eExecutionResult > | ExecResult |
| type used to retrieve an execution result | |
| typedef boost::shared_ptr< boost::thread > | ThreadPtr |
| shared pointer to thread | |
| typedef std::map< ipUInt32, ThreadPtr > | ThreadColl |
| collection of indexed threads | |
| typedef std::map< Guid, ActionProviderPtr > | ProviderMap |
| collection of providers ordered by guid | |
| typedef std::list< ActionProviderPtr > | ProviderList |
| collection of execution providers | |
| typedef std::map< ePriority, ProviderList > | ProviderPriorityColl |
| collection of execution providers ordered by priority | |
| typedef std::list< ActionRequestPtr > | ActionColl |
| collection of action requests | |
| typedef boost::shared_ptr< ProviderManager > | ProviderManagerPtr |
| shared pointer to provider manager | |
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 LocalProcessingPolicy & | getLocalProcessingPolicyConst () |
| retrieve used local processing policy | |
| IPSDKCORE_API LocalProcessingPolicy & | getLocalProcessingPolicy () |
| 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 DistributedProcessingPolicy & | getDistributedProcessingPolicy () |
| 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 LogMessageManager & | getIPSDKCoreLogMessageManager () |
| Recovery of message manager associated to library. | |
Namespace agregating IPSDK core execution routines and classes.
| typedef std::map<Guid, RemoteComputerInfoPtr> ipsdk::core::RemoteComputerInfoMap |
collection of remote computer informations identified by their socket guid
Enumerate describing messages.
Enumerate describing messages.
Enumerate describing library initialization status.
Enumerate describing library path configuration type.
Enumerate describing messages.
Enumerate describing messages.
Enumerate describing messages.
Enumerate describing messages.
Enumerate describing messages.
| 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 |
| 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 |
| 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 |
Enumerate describing messages.
Enumerate describing synchronization type for execution.
Enumerate describing messages.
Enumerate describing messages.
| 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 |
| 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 |
| 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 |
| 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 |
| 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. |
Enumerate describing messages.
| 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 An exception has been thrown while processing provider completion callback for provider with guid 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 |
| 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 |
| eBaseRegisterRemoteProviderInitFailed | Failed to initialize register remote provider action for socket guid 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 |
| 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 |
| eQueryNextActionException | An exception has been thrown during query of next action |
| 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 |
| 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 |
Enumerate describing result of an action query.
| 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. |
Enumerate describing messages.
Enumerate describing action request type.
Enumerate describing priority.
Enumerate describing messages.
Enumerate describing an execution status.
| 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. |
Enumerate describing messages.
| Enumerator | |
|---|---|
| eActionRequestExecutionFailed | Action request execution failed |
| eActionRequestRetrivalBadEnumValue | Bad enumerate return value s for retrieve requested action. |
| eActionRequestRetrivalFailed | Failed to retrieve requested action |
| 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. |
| IPSDKCORE_API const boost::filesystem::path& ipsdk::core::getLibraryPath | ( | const eLibPathConfigType & | libPathConfigType | ) |
function allowing to retrieve a library path configuration type
| ipsdk::core::IPSDKCoreException | if ComputerInfoPool::getInstance().isInit() == false |
| IPSDKCORE_API void ipsdk::core::setAllocatedDiskImagePath | ( | const boost::filesystem::path & | dirPath | ) |
modify the path to the directory where the automatically disk images are created
| ipsdk::core::IPSDKCoreException | if ComputerInfoPool::getInstance().isInit() == false |
1.8.14