This file contains the definitions for the Alert interface. More...

#include "hanfun/common.h"
#include "hanfun/protocol.h"
#include "hanfun/interface.h"

Include dependency graph for alert.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	HF::Interfaces::Alert::Message
	Payload for the Status command. More...

struct	HF::Interfaces::Alert::State
	Helper class to handle the State attribute for the Alert interface. More...

struct	HF::Interfaces::Alert::Enable
	Helper class to handle the Enabled attribute for the Alert interface. More...

struct	HF::Interfaces::Alert::Base
	Alert Interface : Parent. More...

class	HF::Interfaces::Alert::Server
	Alert Interface : Server side implementation. More...

struct	HF::Interfaces::Alert::Client
	Alert Interface : Client side implementation. More...

Namespaces
	HF
	Top-level namespace for the HAN-FUN library.

	HF::Interfaces
	This is the top-level namespace for the implemented Interfaces.

	HF::Interfaces::Alert
	This namespace contains the implementation of the Alert interface.

Enumerations
enum	HF::Interfaces::Alert::CMD { HF::Interfaces::Alert::STATUS_CMD = 0x01 }
	Command IDs. More...

enum	HF::Interfaces::Alert::Attributes { HF::Interfaces::Alert::STATE_ATTR = 0x01, HF::Interfaces::Alert::ENABLE_ATTR = 0x02 }
	Attributes. More...

Functions
HF::Attributes::IAttribute *	HF::Interfaces::create_attribute (HF::Interfaces::Alert::Server *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given `uid`. More...

HF::Attributes::IAttribute *	HF::Interfaces::Alert::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given `uid`. (HF::Interfaces::Alert::Server *,uint8_t) More...

std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::Alert::CMD command)
	Convert the given `command` into a string and write it to the given `stream`. More...

std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::Alert::Attributes attribute)
	Convert the given `attribute` into a string and write it to the given `stream`. More...

Detailed Description

This file contains the definitions for the Alert interface.

For licensing information, please see the file 'LICENSE' in the root folder.

Initial development by Bithium S.A. [http://www.bithium.com]

Definition in file alert.h.

Data Structures