COMMS
Template library intended to help with implementation of communication protocols.
Loading...
Searching...
No Matches
Namespaces | Typedefs | Functions
comms::protocol Namespace Reference

Defines aliases to classes in the comms::frame. More...

Detailed Description

Defines aliases to classes in the comms::frame.

Deprecated:
Use classes comms::frame namespace instead

Namespaces

namespace  checksum
 Defines aliases to classes in the comms::frame::checksum.
 

Typedefs

template<typename TField , typename TCalc , typename TNextLayer , typename... TOptions>
using ChecksumLayer = comms::frame::ChecksumLayer< TField, TCalc, TNextLayer, TOptions... >
 Alias to the comms::frame::ChecksumLayer.
 
template<typename TField , typename TCalc , typename TNextLayer , typename... TOptions>
using ChecksumPrefixLayer = comms::frame::ChecksumPrefixLayer< TField, TCalc, TNextLayer, TOptions... >
 Alias to the comms::frame::ChecksumPrefixLayer.
 
template<typename... TOptions>
using MsgDataLayer = comms::frame::MsgDataLayer< TOptions... >
 Alias to the comms::frame::MsgDataLayer.
 
template<typename TField , typename TMessage , typename TAllMessages , typename TNextLayer , typename... TOptions>
using MsgIdLayer = comms::frame::MsgIdLayer< TField, TMessage, TAllMessages, TNextLayer, TOptions... >
 Alias to the comms::frame::MsgIdLayer.
 
template<typename TField , typename TNextLayer , typename... TOptions>
using MsgSizeLayer = comms::frame::MsgSizeLayer< TField, TNextLayer, TOptions... >
 Alias to the comms::frame::MsgSizeLayer.
 
template<typename TField , typename TNextLayer , typename TDerived , typename... TOptions>
using ProtocolLayerBase = comms::frame::FrameLayerBase< TField, TNextLayer, TDerived, TOptions... >
 Alias to the comms::frame::FrameLayerBase.
 
template<typename TField , typename TNextLayer , typename... TOptions>
using SyncPrefixLayer = comms::frame::SyncPrefixLayer< TField, TNextLayer, TOptions... >
 Alias to the comms::frame::SyncPrefixLayer.
 
template<typename TField , std::size_t TIdx, typename TNextLayer , typename... TOptions>
using TransportValueLayer = comms::frame::TransportValueLayer< TField, TIdx, TNextLayer, TOptions... >
 Alias to the comms::frame::TransportValueLayer.
 

Functions

auto missingSize (std::size_t &val) -> decltype(comms::frame::missingSize(val))
 Same as comms::frame::missingSize()
 
template<typename TId >
auto msgId (TId &val) -> decltype(comms::frame::msgId(val))
 Same as comms::frame::msgId()
 
auto msgIndex (std::size_t &val) -> decltype(comms::frame::msgIndex(val))
 Same as comms::frame::msgIndex()
 
template<typename TIter >
auto msgPayload (TIter &iter, std::size_t &len) -> decltype(comms::frame::msgPayload(iter, len))
 Same as comms::frame::msgPayload()
 
template<typename TField , typename TNextLayer , typename TDerived , typename... TOptions>
constexpr auto toFrameLayerBase (const ProtocolLayerBase< TField, TNextLayer, TDerived, TOptions... > &layer) -> decltype(comms::frame::toFrameLayerBase(layer))
 Same as comms::frame::toFrameLayerBase()
 
template<typename TField , typename TNextLayer , typename TDerived , typename... TOptions>
auto toProtocolLayerBase (ProtocolLayerBase< TField, TNextLayer, TDerived, TOptions... > &layer) -> decltype(comms::frame::toFrameLayerBase(layer))
 Same as comms::frame::toFrameLayerBase()
 

Typedef Documentation

◆ ChecksumLayer

template<typename TField , typename TCalc , typename TNextLayer , typename... TOptions>
using comms::protocol::ChecksumLayer = typedef comms::frame::ChecksumLayer<TField, TCalc, TNextLayer, TOptions...>

◆ ChecksumPrefixLayer

template<typename TField , typename TCalc , typename TNextLayer , typename... TOptions>
using comms::protocol::ChecksumPrefixLayer = typedef comms::frame::ChecksumPrefixLayer<TField, TCalc, TNextLayer, TOptions...>

◆ MsgDataLayer

template<typename... TOptions>
using comms::protocol::MsgDataLayer = typedef comms::frame::MsgDataLayer<TOptions...>

◆ MsgIdLayer

template<typename TField , typename TMessage , typename TAllMessages , typename TNextLayer , typename... TOptions>
using comms::protocol::MsgIdLayer = typedef comms::frame::MsgIdLayer<TField, TMessage, TAllMessages, TNextLayer, TOptions...>

◆ MsgSizeLayer

template<typename TField , typename TNextLayer , typename... TOptions>
using comms::protocol::MsgSizeLayer = typedef comms::frame::MsgSizeLayer<TField, TNextLayer, TOptions...>

◆ ProtocolLayerBase

template<typename TField , typename TNextLayer , typename TDerived , typename... TOptions>
using comms::protocol::ProtocolLayerBase = typedef comms::frame::FrameLayerBase<TField, TNextLayer, TDerived, TOptions...>

◆ SyncPrefixLayer

template<typename TField , typename TNextLayer , typename... TOptions>
using comms::protocol::SyncPrefixLayer = typedef comms::frame::SyncPrefixLayer<TField, TNextLayer, TOptions...>

◆ TransportValueLayer

template<typename TField , std::size_t TIdx, typename TNextLayer , typename... TOptions>
using comms::protocol::TransportValueLayer = typedef comms::frame::TransportValueLayer<TField, TIdx, TNextLayer, TOptions...>

Function Documentation

◆ missingSize()

auto comms::protocol::missingSize ( std::size_t &  val) -> decltype(comms::frame::missingSize(val))

◆ msgId()

template<typename TId >
auto comms::protocol::msgId ( TId &  val) -> decltype(comms::frame::msgId(val))

◆ msgIndex()

auto comms::protocol::msgIndex ( std::size_t &  val) -> decltype(comms::frame::msgIndex(val))

◆ msgPayload()

template<typename TIter >
auto comms::protocol::msgPayload ( TIter &  iter,
std::size_t &  len 
) -> decltype(comms::frame::msgPayload(iter, len))

◆ toFrameLayerBase()

template<typename TField , typename TNextLayer , typename TDerived , typename... TOptions>
constexpr auto comms::protocol::toFrameLayerBase ( const ProtocolLayerBase< TField, TNextLayer, TDerived, TOptions... > &  layer) -> decltype(comms::frame::toFrameLayerBase(layer))
constexpr

◆ toProtocolLayerBase()

template<typename TField , typename TNextLayer , typename TDerived , typename... TOptions>
auto comms::protocol::toProtocolLayerBase ( ProtocolLayerBase< TField, TNextLayer, TDerived, TOptions... > &  layer) -> decltype(comms::frame::toFrameLayerBase(layer))