comms_doc/comms_8h_source.html

//

// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.

//

// This Source Code Form is subject to the terms of the Mozilla Public

// License, v. 2.0. If a copy of the MPL was not distributed with this

// file, You can obtain one at http://mozilla.org/MPL/2.0/.


#pragma once


#include "comms/CompileControl.h"

#include "comms/fields.h"

#include "comms/protocols.h"

#include "comms/units.h"

#include "comms/version.h"

#include "comms/dispatch.h"

#include "comms/field_cast.h"

#include "comms/iterator.h"

#include "process.h"


#include "comms/Message.h"

#include "comms/EmptyHandler.h"

#include "comms/GenericHandler.h"

#include "comms/MessageBase.h"

#include "comms/MsgFactory.h"

#include "comms/MsgDispatcher.h"

#include "comms/GenericMessage.h"


#include "comms/util/detect.h"

#include "comms/util/assign.h"

#include "comms/util/type_traits.h"

CompileControl.h
Contains various compiler related definitions.

EmptyHandler.h
Contains definition of comms::EmptyHandler class.

GenericHandler.h
This file contains definition of common handler.

GenericMessage.h
Provides implementation of comms::GenericMessage class.

MessageBase.h
Provides common base class for the custom messages with default implementation.

Message.h
Contains definition of Message object interface and various base classes for custom messages.

MsgDispatcher.h
Contains definition of MsgDispatcher class which facilitates dispatching of message object to appropr...

MsgFactory.h
Contains definition of comms::MsgFactory class.

assign.h
Provides helper assign() function to allow easy assignment of values to collections or views.

dispatch.h
Contains extra logic to help with dispatching message types and objects.

field_cast.h
Contained definition of field_cast() function. Now deprecated, use "comms/cast.h" instead.

fields.h
This file provides all the definitions from comms::field namespace.

iterator.h
Provides auxiliary functions for retrieving best type of iterator for read/write operations.

process.h
Provides auxiliary functions for processing input and dispatching messages.

protocols.h
This file provides all the definitions from comms::protocol namespace.

type_traits.h
Replacement to some types from standard type_traits.

units.h
This file contains all the functions required for proper units conversion.

detect.h
Various compile-time detection functions of whether specific member functions and/or types exist.

version.h
Contains version information of the library.