HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Common::IEntries< T > Struct Template Referenceabstract

Basic API for persistent storage implementations. More...

#include <common.h>

+ Collaboration diagram for HF::Common::IEntries< T >:

Public Member Functions

virtual uint16_t size () const =0
 Return the number of entries in the container. More...
 
virtual Result save (const T &entry)=0
 Store the given entry to persistent storage. More...
 
virtual Result destroy (const T &entry)=0
 Destroy the given entry in the persistent storage. More...
 

Detailed Description

template<typename T>
struct HF::Common::IEntries< T >

Basic API for persistent storage implementations.

Definition at line 1302 of file inc/hanfun/common.h.

Member Function Documentation

◆ destroy()

template<typename T>
virtual Result HF::Common::IEntries< T >::destroy ( const T &  entry)
pure virtual

Destroy the given entry in the persistent storage.

Parameters
[in]entryreference to the entry to erase.
Return values
Common::Result::OK,ifthe entry was destroyed.
Common::Result::FAIL_ARGotherwise.

◆ save()

template<typename T>
virtual Result HF::Common::IEntries< T >::save ( const T &  entry)
pure virtual

Store the given entry to persistent storage.

Parameters
[in]entrythe entry to save to storage.
Return values
Common::Result::OKif the entry was saved,
Common::Result::FAIL_UNKNOWNotherwise.

◆ size()

template<typename T>
virtual uint16_t HF::Common::IEntries< T >::size ( ) const
pure virtual

Return the number of entries in the container.

Returns
the number of entries in the container.

Implemented in HF::Core::DeviceManagement::Entries, HF::Core::GroupManagement::Entries, HF::Core::BindManagement::Entries, HF::Core::Scheduling::Entries< _Type >, HF::Core::BatchProgramManagement::Entries, and HF::Core::GroupTable::Entries.

Referenced by HF::Core::GroupManagement::IServer::number_of_groups().

+ Here is the caller graph for this function:

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