IDaemon Class Reference

IDaemon interface. More...

#include <IDaemon.h>

Inheritance diagram for IDaemon:

Public Member Functions
virtual	~IDaemon ()
virtual void	executeDpaTransaction (DpaTransaction &dpaTransaction)=0
	Execute DPA transaction. More...
virtual void	registerAsyncMessageHandler (const std::string &clientId, AsyncMessageHandlerFunc fun)=0
	Register Asynchronous DPA message handler. More...
virtual void	unregisterAsyncMessageHandler (const std::string &clientId)=0
	Unregister Asynchronous DPA message handler. More...
virtual IScheduler *	getScheduler ()=0
	Get IScheduler implementation. More...
virtual std::string	doCommand (const std::string &cmd)=0
	Perform mode switch command. More...
virtual const std::string &	getModuleId ()=0
	Get IQRF coordination identification. More...
virtual const std::string &	getOsVersion ()=0
	Get IQRF coordination OS version. More...
virtual const std::string &	getTrType ()=0
	Get IQRF coordination TR type. More...
virtual const std::string &	getMcuType ()=0
	Get IQRF coordination MCU type. More...
virtual const std::string &	getOsBuild ()=0
	Get IQRF coordination OS build. More...
virtual const std::string &	getDaemonVersion ()=0
	Get iqrf-daemon Version. More...
virtual const std::string &	getDaemonVersionBuild ()=0
	Get iqrf-daemon build Timestamp. More...

Detailed Description

IDaemon interface.

Constructor & Destructor Documentation

~IDaemon()

virtual IDaemon::~IDaemon ( )

inlinevirtual

Member Function Documentation

doCommand()

virtual std::string IDaemon::doCommand ( const std::string &  cmd )

pure virtual

Perform mode switch command.

Parameters

[in]

cmd

command to switch mode

Returns

result of the command

Switches communication mode to oparational, forwarding or service according the command Supported command strings are: "operational" | "service" | "forwarding"

Implemented in DaemonController.

executeDpaTransaction()

virtual void IDaemon::executeDpaTransaction ( DpaTransaction &  dpaTransaction )

pure virtual

Execute DPA transaction.

Parameters

[in]

dpaTransaction

Transaction to be executed

The transaction consists from DPA requeste sent to coordinator. It is finished by DPA response or timeout

Implemented in DaemonController.

getDaemonVersion()

virtual const std::string& IDaemon::getDaemonVersion ( )

pure virtual

Get iqrf-daemon Version.

Returns

Version

Version is hardcoded during build, e.g. "v1.0.0"

Implemented in DaemonController.

getDaemonVersionBuild()

virtual const std::string& IDaemon::getDaemonVersionBuild ( )

pure virtual

Get iqrf-daemon build Timestamp.

Returns

Timestamp

Timestamp is hardcoded during build, e.g. "Fri 06/23/2017 9:53:37.74"

Implemented in DaemonController.

getMcuType()

virtual const std::string& IDaemon::getMcuType ( )

pure virtual

Get IQRF coordination MCU type.

Returns

MCU type

MCU type is taken from the coordinator at the initialization phase, e.g. "PIC16F1938"

Implemented in DaemonController.

getModuleId()

virtual const std::string& IDaemon::getModuleId ( )

pure virtual

Get IQRF coordination identification.

Returns

Module ID Module ID is taken from the coordinator at the initialization phase, e.g. "8100528a"

Implemented in DaemonController.

getOsBuild()

virtual const std::string& IDaemon::getOsBuild ( )

pure virtual

Get IQRF coordination OS build.

Returns

OS build

OS build is taken from the coordinator at the initialization phase, e.g. "0879"

Implemented in DaemonController.

getOsVersion()

virtual const std::string& IDaemon::getOsVersion ( )

pure virtual

Get IQRF coordination OS version.

Returns

OS version

OS version is taken from the coordinator at the initialization phase, e.g. "3.08D"

Implemented in DaemonController.

getScheduler()

virtual IScheduler* IDaemon::getScheduler ( )

pure virtual

Get IScheduler implementation.

Returns

IScheduler implementation

Provides an instance of IScheduler implementation.

Implemented in DaemonController.

getTrType()

virtual const std::string& IDaemon::getTrType ( )

pure virtual

Get IQRF coordination TR type.

Returns

TR type

TR type is taken from the coordinator at the initialization phase, e.g. "DCTR-72D"

Implemented in DaemonController.

registerAsyncMessageHandler()

virtual void IDaemon::registerAsyncMessageHandler ( const std::string &  clientId, AsyncMessageHandlerFunc  fun  )

pure virtual

Register Asynchronous DPA message handler.

Parameters

[in]	clientId	client identification registering handler function
[in]	fun	handler function

Whenever an asynchronous DPA message is received its passed to the handler function. It is possible to register more handlers for different clients distinguished via client identifications. All registered handlers are invoked to handle the message, however the order is not quaranteed. Repeated registration with the same client identification replaces previously registered handler

Implemented in DaemonController.

unregisterAsyncMessageHandler()

virtual void IDaemon::unregisterAsyncMessageHandler ( const std::string &  clientId )

pure virtual

Unregister Asynchronous DPA message handler.

Parameters

[in]

clientId

client identification

If the handler is not required anymore, it is possible to unregister via this method.

Implemented in DaemonController.

---

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

• daemon/include/IDaemon.h