nx_cloud_storage_sdk  1.0
Cloud Storage SDK
Public Member Functions | Static Public Member Functions | List of all members
nx::sdk::cloud_storage::IArchiveUpdateHandler Class Referenceabstract

#include <i_archive_update_handler.h>

Inheritance diagram for nx::sdk::cloud_storage::IArchiveUpdateHandler:
nx::sdk::Interface< IArchiveUpdateHandler > nx::sdk::IRefCountable

Public Member Functions

virtual void onArchiveUpdated (const char *engineId, nx::sdk::ErrorCode errorCode, const IList< IDeviceArchive > *deviceArchive) const =0
 
- Public Member Functions inherited from nx::sdk::Interface< IArchiveUpdateHandler >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class Interface >
Ptr< InterfacequeryInterface ()
 
template<class Interface >
Ptr< const InterfacequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static constexpr auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Additional Inherited Members

- Protected Member Functions inherited from nx::sdk::Interface< IArchiveUpdateHandler >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 

Detailed Description

A pointer to the this class instance is provided to the engine when IPlugin::createEngine() is called. The engine should use it to periodically inform Server about any Archive changes.

Member Function Documentation

◆ onArchiveUpdated()

virtual void nx::sdk::cloud_storage::IArchiveUpdateHandler::onArchiveUpdated ( const char *  engineId,
nx::sdk::ErrorCode  errorCode,
const IList< IDeviceArchive > *  deviceArchive 
) const
pure virtual

Engine should call this periodically to check if something is changed on the backend. I.e. some data was removed due to the retention policy, new data has been recorded, new device appeared. The deviceArchive may be destroyed by the plugin right after the onArchiveUpdated function has returned.


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