Communication endpoint identifier. More...

#include <cstdint>
#include <string>
#include "sensorring/platform/SensorringExport.hpp"

Include dependency graph for ComEndpoint.hpp:

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

Classes
struct	eduart::sensorring::com::ComEndpoint
	Uniquely identifies a communication endpoint as a (Direction, BoardAddress, DeviceId) tuple. More...
struct	std::hash< eduart::sensorring::com::ComEndpoint >
	Hash function for ComEndpoint, allowing use in unordered containers. More...

Enumerations
enum class	eduart::sensorring::com::Direction : std::uint8_t { Input = 0 , Broadcast = 0 , Output = 1 }
	Communication direction on the CAN bus, from the board's perspective. More...

Functions
bool	eduart::sensorring::com::endpointMatches (const ComEndpoint &subscription, const ComEndpoint &incoming)
	Check whether a subscription endpoint matches an incoming endpoint.

Detailed Description

Communication endpoint identifier.

Enumeration Type Documentation

strong

Communication direction on the CAN bus, from the board's perspective.

Enumerator
Input	Host -> Board (board receives).
Broadcast	Alias for Input; used with broadcast board address.
Output	Board -> Host (board sends).

bool eduart::sensorring::com::endpointMatches	(	const ComEndpoint &	subscription,
		const ComEndpoint &	incoming )

inline

Check whether a subscription endpoint matches an incoming endpoint.

Supports the ANY_BOARD wildcard: if subscription.boardAddress == ANY_BOARD, it matches any incoming board address.