protocol.h File Reference

This file contains the definitions for the HAN-FUN protocol messages. More...

#include "hanfun/common.h"

Include dependency graph for protocol.h:

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

Go to the source code of this file.

Data Structures
struct	HF::Protocol::Message
	Network Message. More...
struct	HF::Protocol::Message::Interface
	Interface Address. More...
struct	HF::Protocol::Address
	Network Address. More...
struct	HF::Protocol::Packet
	HAN-FUN Protocol Packet. More...
struct	HF::Protocol::Response
	Parent class for the response messages. More...
class	HF::Protocol::Filters::ResponseRequired
	This class provides support for generating a response when a response is required from an incoming message received, but no response was generated. More...
struct	HF::Protocol::Filters::ResponseRequired::Entry
	Filter database entry. More...

Namespaces
	HF
	Top-level namespace for the HAN-FUN library.
	HF::Transport
	This is the top-level namespace for the transport layer API.
	HF::Protocol
	HAN-FUN Protocol implementation.
	HF::Protocol::Filters
	This namespace contains the different packet filters.

Functions
bool	HF::Protocol::request (Message::Type type, bool response=false)
	Check if message type is a request. More...
bool	HF::Protocol::response (Message::Type type)
	Check if message is a response. More...
bool	HF::Protocol::matches (Message::Type lhs, Message::Type rhs)
	Check if the given message types are the request and response for each other, for example, the Message::Type::COMMAND_RES matches both the Message::Type::COMMAND_REQ and Message::Type::COMMAND_RESP_REQ. More...
std::ostream &	operator<< (std::ostream &stream, const HF::Protocol::Message::Type type)
	Convert the given message type into a string and write it to the given stream. More...
std::ostream &	operator<< (std::ostream &stream, const HF::Protocol::Message &message)
	Convert the given message into a string and write it to the given stream. More...
std::ostream &	operator<< (std::ostream &stream, const HF::Protocol::Address &address)
	Convert the given address into a string and write it to the given stream. More...
std::ostream &	operator<< (std::ostream &stream, const HF::Protocol::Packet &packet)
	Convert the given packet into a string and write it to the given stream. More...

Variables
constexpr uint16_t	HF::Protocol::BROADCAST_ADDR = 0x7FFF
	HAN-FUN Broadcast - device address.
constexpr uint8_t	HF::Protocol::BROADCAST_UNIT = 0xFF
	HAN-FUN Broadcast - unit address.
constexpr uint16_t	HF::Protocol::MAX_PAYLOAD = 0x01FF
	HAN-FUN Network - Maximum application payload length.

Detailed Description

This file contains the definitions for the HAN-FUN protocol messages.

Version

1.5.3

Copyright

Copyright ©   2014 ULE Alliance

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 protocol.h.