CHAI SDK  Version 1.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CPNS::IBaseLocalDevice_SnapshotNotificationHandler Class Referenceabstract

Notification handler for the base local device snapshot handling. More...

Public Member Functions

virtual CPNS::boolean OnBaseLocalDevice_RequestCollectSnapshotData (CPNS::IBaseLocalDevice *const pNotifiedObject, CPNS::uint16 const wRequestID, CPNS::Enums::SnapshotTypes const type, CPNS::uint32 const dwOffset, CPNS::uint32 const dwContextData, CPNS::uint16 const wMaxBlockSize)=0
 Called by the CHAI to request snapshot data related to the device This method should call IBaseLocalDevice::Reply_InvalidRequest | IBaseLocalDevice::Reply_RequestCollectSnapshotData. More...
 
virtual CPNS::boolean OnBaseLocalDevice_RequestRestoreSnapshotData (CPNS::IBaseLocalDevice *const pNotifiedObject, CPNS::uint16 const wRequestID, CPNS::Enums::SnapshotTypes const type, CPNS::uint32 const dwOffset, CPNS::uint32 const dwContextData, CPNS::uint16 const wBlockSize, CPNS::boolean const fLastBlock, CPNS::byte const *const pBlockData)=0
 Called by the CHAI to restore snapshot data related to the device This method should call IBaseLocalDevice::Reply_InvalidRequest | IBaseLocalDevice::Reply_RequestRestoreSnapshotData. More...
 

Detailed Description

Notification handler for the base local device snapshot handling.

See Also
IBaseLocalDevice::SetSnapshotNotificationHandler

Member Function Documentation

virtual CPNS::boolean CPNS::IBaseLocalDevice_SnapshotNotificationHandler::OnBaseLocalDevice_RequestCollectSnapshotData ( CPNS::IBaseLocalDevice *const  pNotifiedObject,
CPNS::uint16 const  wRequestID,
CPNS::Enums::SnapshotTypes const  type,
CPNS::uint32 const  dwOffset,
CPNS::uint32 const  dwContextData,
CPNS::uint16 const  wMaxBlockSize 
)
pure virtual

Called by the CHAI to request snapshot data related to the device This method should call IBaseLocalDevice::Reply_InvalidRequest | IBaseLocalDevice::Reply_RequestCollectSnapshotData.

Returns
FALSE to signal a not supported request, TRUE if the request is supported
Parameters
[in]pNotifiedObjectPointer to the requested local device
[in]wRequestIDID of the request, must be passed to the corresponding IBaseLocalDevice::Reply_Request* method
[in]typeRequested snapshot information type
[in]dwOffsetData offset. First call is done with an offset 0.
[in]dwContextDataContext data related to the collected device. 0 during the 1st call, then value transmitted with the previous reply
[in]wMaxBlockSizeMaximum size of the data block
virtual CPNS::boolean CPNS::IBaseLocalDevice_SnapshotNotificationHandler::OnBaseLocalDevice_RequestRestoreSnapshotData ( CPNS::IBaseLocalDevice *const  pNotifiedObject,
CPNS::uint16 const  wRequestID,
CPNS::Enums::SnapshotTypes const  type,
CPNS::uint32 const  dwOffset,
CPNS::uint32 const  dwContextData,
CPNS::uint16 const  wBlockSize,
CPNS::boolean const  fLastBlock,
CPNS::byte const *const  pBlockData 
)
pure virtual

Called by the CHAI to restore snapshot data related to the device This method should call IBaseLocalDevice::Reply_InvalidRequest | IBaseLocalDevice::Reply_RequestRestoreSnapshotData.

Returns
FALSE to signal a not supported request, TRUE if the request is supported
Parameters
[in]pNotifiedObjectPointer to the requested local device
[in]wRequestIDID of the request, must be passed to the corresponding IBaseLocalDevice::Reply_Request* method
[in]typeSnapshot data information type
[in]dwOffsetData block offset. First call is done with an offset 0.
[in]dwContextDataContext data related to the collected device. 0 during the 1st call, then value transmitted with the previous reply
[in]wBlockSizeData block size
[in]fLastBlockTRUE if this is the last block
[in]pBlockDataPointer to the data block