HF::Core::DeviceManagement::IEntries Struct Reference

Device Management - Persistent Storage API. More...

#include <device_management.h>

Inheritance diagram for HF::Core::DeviceManagement::IEntries:

Collaboration diagram for HF::Core::DeviceManagement::IEntries:

Public Member Functions
virtual DevicePtr	find (uint16_t address) const =0
	Return the Device entry for the given address. More...
virtual DevicePtr	find (const HF::UID::UID &uid) const =0
	Return the Device entry for the given UID. More...
virtual uint16_t	next_address () const =0
	Return next available address for registering a device. More...
Public Member Functions inherited from HF::Common::IEntries< Device >
virtual uint16_t	size () const=0
	Return the number of entries in the container. More...
virtual Result	save (const Device &entry)=0
	Store the given entry to persistent storage. More...
virtual Result	destroy (const Device &entry)=0
	Destroy the given entry in the persistent storage. More...

Detailed Description

Device Management - Persistent Storage API.

Definition at line 344 of file device_management.h.

Member Function Documentation

find() [1/2]

virtual DevicePtr HF::Core::DeviceManagement::IEntries::find ( uint16_t  address ) const

pure virtual

Return the Device entry for the given address.

Parameters

[in]

address

the device address.

Return values

a	pointer to the Device entry associated with the given address,
nullptr	if the entry does not exist.

Implemented in HF::Core::DeviceManagement::Entries.

Referenced by HF::Core::DeviceManagement::IServer::entry().

Here is the caller graph for this function:

find() [2/2]

virtual DevicePtr HF::Core::DeviceManagement::IEntries::find ( const HF::UID::UID &  uid ) const

pure virtual

Return the Device entry for the given UID.

Parameters

[in]

uid

the device UID.

Return values

a	pointer the Device entry associated with the given UID,
nullptr	if the entry does not exist.

Implemented in HF::Core::DeviceManagement::Entries.

next_address()

virtual uint16_t HF::Core::DeviceManagement::IEntries::next_address ( ) const

pure virtual

Return next available address for registering a device.

Returns

the address to use in the next registration.

Implemented in HF::Core::DeviceManagement::Entries.

Referenced by HF::Core::DeviceManagement::IServer::next_address().

Here is the caller graph for this function:

---

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

• device_management.h