mx::IAsyncRetrieveCommit Class Reference
[Component Interfaces]

Object implementing this interface describes a way for asynchronous client/camera communication. More...

#include <IAsyncRetrieveCommit.h>

Inheritance diagram for mx::IAsyncRetrieveCommit:

mx::IInterface mx::IConfigSession mx::IPTZSession List of all members.

Public Member Functions

virtual void retrieve (mxmStringList &supportedInterfaces, const mxmQtSlot &slot, void *context, u32 uTimeOutMs=5000)=0
virtual bool isRetrieved (const mxmString &supportedInterface)=0
virtual bool isRetrieving (const mxmString &supportedInterface)=0
virtual bool isCommitting ()=0
virtual mx::EErrorCode cancelAsyncRequest ()=0
virtual void commit (const mxmQtSlot &slot, void *context, u32 uTimeOutMs=5000, bool bStorePermanent=false)=0

Static Public Attributes

static const u32 NoTimeout = (u32)(-1)

Detailed Description

Object implementing this interface describes a way for asynchronous client/camera communication.


Member Function Documentation

virtual mx::EErrorCode mx::IAsyncRetrieveCommit::cancelAsyncRequest  )  [pure virtual]
 

cancel the last retrieve or commit request

virtual void mx::IAsyncRetrieveCommit::commit const mxmQtSlot slot,
void *  context,
u32  uTimeOutMs = 5000,
bool  bStorePermanent = false
[pure virtual]
 

send all changed attributes to the camera The slot method has the following signature: void method(enum EHttpError error, void* context). if bStorePermanent is true, the data will be saved permanently on the camera.

virtual bool mx::IAsyncRetrieveCommit::isCommitting  )  [pure virtual]
 

check if the commit in progress

virtual bool mx::IAsyncRetrieveCommit::isRetrieved const mxmString supportedInterface  )  [pure virtual]
 

check if a supported inteface is already retrieved

virtual bool mx::IAsyncRetrieveCommit::isRetrieving const mxmString supportedInterface  )  [pure virtual]
 

check if retrieving the supported interface is currently executed

virtual void mx::IAsyncRetrieveCommit::retrieve mxmStringList supportedInterfaces,
const mxmQtSlot slot,
void *  context,
u32  uTimeOutMs = 5000
[pure virtual]
 

retrieve the settings from the camera for the supported interfaces i.e. ISupportsRecordingConfiguration, ... before you can get any property the retrieve method must be called succesfully, an exception is thrown otherwise NOTE: if there is a dependency of an attribute to an attribute of another interface section not listed in supportedInterfaces, this method adds the other interface to the list before retrieval. The slot method has the following signature: void method(enum EHttpError error, void* context).

Parameters:
supportedInterfaces 
slot 
context 
uTimeOutMs Maximum time to wait for retrieval. If 0, the method returns immediately, if NoTimeout, the method potentially waits forever.


The documentation for this class was generated from the following file:
Generated on Fri Jun 29 17:21:05 2007 for MxPEG SDK by  doxygen 1.4.6