knx: SecurityInterfaceObject Class Reference

knx

ETS configurable knx-stack

#include <security_interface_object.h>

Inheritance diagram for SecurityInterfaceObject:

Collaboration diagram for SecurityInterfaceObject:

Public Member Functions
	SecurityInterfaceObject ()

void	masterReset (EraseCode eraseCode, uint8_t channel) override

bool	isSecurityModeEnabled ()

bool	isLoaded ()

const uint8_t *	toolKey ()

const uint8_t *	p2pKey (uint16_t addressIndex)

const uint8_t *	groupKey (uint16_t addressIndex)

uint16_t	indAddressIndex (uint16_t indAddr)

void	setSequenceNumber (bool toolAccess, uint64_t seqNum)

uint64_t	getLastValidSequenceNumber (uint16_t deviceAddr)

void	setLastValidSequenceNumber (uint16_t deviceAddr, uint64_t seqNum)

DataSecurity	getGroupObjectSecurity (uint16_t index)

LoadState	loadState ()

uint8_t *	save (uint8_t *buffer) override
	This method is called when the object should save its state to the buffer. More...

const uint8_t *	restore (const uint8_t *buffer) override
	This method is called when the object should restore its state from the buffer. More...

uint16_t	saveSize () override

Public Member Functions inherited from InterfaceObject
virtual	~InterfaceObject ()
	Destructor. More...

virtual void	readPropertyLength (PropertyID id, uint16_t &length)
	Read length of a property of the interface object. More...

virtual void	readProperty (PropertyID id, uint16_t start, uint8_t &count, uint8_t *data)
	Read a property of the interface object. More...

virtual void	writeProperty (PropertyID id, uint16_t start, uint8_t *data, uint8_t &count)
	Write property of the interface object. More...

virtual uint8_t	propertySize (PropertyID id)
	Gets the size of of property in bytes. More...

virtual void	command (PropertyID id, uint8_t data, uint8_t length, uint8_t resultData, uint8_t &resultLength)
	Call command of a function property of the interface object. More...

virtual void	state (PropertyID id, uint8_t data, uint8_t length, uint8_t resultData, uint8_t &resultLength)
	Get state of a function property of the interface object. More...

void	readPropertyDescription (uint8_t &propertyId, uint8_t &propertyIndex, bool &writeEnable, uint8_t &type, uint16_t &numberOfElements, uint8_t &access)
	Read the Description of a property of the interface object. More...

Property *	property (PropertyID id)
	Gets property with PropertyID id if it exists and nullptr otherwise. More...

template<typename T >
T	propertyValue (PropertyID id)

template<typename T >
void	propertyValue (PropertyID id, T value)

const uint8_t *	propertyData (PropertyID id)

const uint8_t *	propertyData (PropertyID id, uint16_t elementIndex)

const Property *	property (PropertyID id) const
	Gets const property with PropertyID id if it exists and nullptr otherwise. More...

Additional Inherited Members
Protected Member Functions inherited from InterfaceObject
virtual void	initializeProperties (size_t propertiesSize, Property **properties)
	Intializes the Property-array the the supplied values. More...

Protected Attributes inherited from InterfaceObject
Property **	_properties = nullptr

uint8_t	_propertyCount = 0

Detailed Description

Definition at line 9 of file security_interface_object.h.

Constructor & Destructor Documentation

◆ SecurityInterfaceObject()

SecurityInterfaceObject::SecurityInterfaceObject ( )

Definition at line 17 of file security_interface_object.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ getGroupObjectSecurity()

DataSecurity SecurityInterfaceObject::getGroupObjectSecurity ( uint16_t index )

Definition at line 585 of file security_interface_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastValidSequenceNumber()

uint64_t SecurityInterfaceObject::getLastValidSequenceNumber ( uint16_t deviceAddr )

Definition at line 532 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ groupKey()

const uint8_t * SecurityInterfaceObject::groupKey ( uint16_t addressIndex )

Definition at line 438 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ indAddressIndex()

uint16_t SecurityInterfaceObject::indAddressIndex ( uint16_t indAddr )

Definition at line 473 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ isLoaded()

bool SecurityInterfaceObject::isLoaded ( )

Definition at line 235 of file security_interface_object.cpp.

Here is the caller graph for this function:

◆ isSecurityModeEnabled()

bool SecurityInterfaceObject::isSecurityModeEnabled ( )

Definition at line 212 of file security_interface_object.cpp.

Here is the caller graph for this function:

◆ loadState()

LoadState SecurityInterfaceObject::loadState ( )

Definition at line 240 of file security_interface_object.cpp.

Here is the caller graph for this function:

◆ masterReset()

void SecurityInterfaceObject::masterReset	(	EraseCode	eraseCode,
		uint8_t	channel
	)

overridevirtual

Reimplemented from InterfaceObject.

Definition at line 385 of file security_interface_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ p2pKey()

const uint8_t * SecurityInterfaceObject::p2pKey ( uint16_t addressIndex )

Definition at line 403 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ restore()

const uint8_t * SecurityInterfaceObject::restore ( const uint8_t * buffer )

overridevirtual

This method is called when the object should restore its state from the buffer.

Parameters

buffer The buffer the object should restore its state from.

Returns: The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

Reimplemented from InterfaceObject.

Definition at line 187 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ save()

uint8_t * SecurityInterfaceObject::save ( uint8_t * buffer )

overridevirtual

This method is called when the object should save its state to the buffer.

Parameters

buffer The buffer the object should save its state to.

Returns: The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

Reimplemented from InterfaceObject.

Definition at line 179 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ saveSize()

uint16_t SecurityInterfaceObject::saveSize ( )

overridevirtual

Returns: The maximum number of bytes the object needs to save its state.

Reimplemented from InterfaceObject.

Definition at line 200 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ setLastValidSequenceNumber()

void SecurityInterfaceObject::setLastValidSequenceNumber	(	uint16_t	deviceAddr,
		uint64_t	seqNum
	)

Definition at line 559 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ setSequenceNumber()

void SecurityInterfaceObject::setSequenceNumber	(	bool	toolAccess,
		uint64_t	seqNum
	)

Definition at line 501 of file security_interface_object.cpp.

Here is the call graph for this function:

◆ toolKey()

const uint8_t * SecurityInterfaceObject::toolKey ( )

Definition at line 396 of file security_interface_object.cpp.

Here is the call graph for this function:

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

src/knx/security_interface_object.h
src/knx/security_interface_object.cpp

SecurityInterfaceObject
Generated by 1.9.1