IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
ipsdk::core::PendingActionRequestManager Class Reference

Singleton class allowing to store and manage pending action requests. More...

#include <PendingActionRequestManager.h>

Inheritance diagram for ipsdk::core::PendingActionRequestManager:

Public Member Functions

 ~PendingActionRequestManager ()
 destructor
 
void registerRequest (const PendingActionRequestPtr &pRequest)
 method allowing to register a new pending action request More...
 
bool isRegistredRequest (const Guid &requestGuid) const
 method allowing to test whether a given request guid is registred
 
PendingActionRequestPtr releaseRequest (const Guid &requestGuid)
 method allowing to release a request given its guid More...
 

Static Public Member Functions

static PendingActionRequestManagergetInstance ()
 retrieve unique instance of singeton object
 

Protected Types

typedef std::map< Guid, PendingActionRequestPtrRequestMap
 collection allowing to associated a guid to a request
 

Protected Member Functions

 PendingActionRequestManager ()
 constructor
 

Protected Attributes

boost::mutex _mutex
 mutex allowing to lock object data during execution
 
RequestMap _requestMap
 collection of registred requests
 

Detailed Description

Singleton class allowing to store and manage pending action requests.

Author
E. Noirfalise
Date
2015/10/29

Member Function Documentation

◆ registerRequest()

void ipsdk::core::PendingActionRequestManager::registerRequest ( const PendingActionRequestPtr pRequest)

method allowing to register a new pending action request

Exceptions
ipsdk::core::IPSDKCoreExceptionif pRequest.get() == 0
ipsdk::core::IPSDKCoreExceptionif isRegistredRequest(pRequest->getGuid()) == true

◆ releaseRequest()

PendingActionRequestPtr ipsdk::core::PendingActionRequestManager::releaseRequest ( const Guid requestGuid)

method allowing to release a request given its guid

Returns
null shared pointer if request is not found

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