Release v5.4.1

Author: arobenko

doxygen/page_custom_checksum_layer.dox

@@ -298,7 +298,7 @@
 ///     >
 /// {
 ///     // Generate convenience access functions for various layers
-///     COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(checksum, size, size, checksumType, payload);
+///     COMMS_FRAME_LAYERS_ACCESS_OUTER(checksum, size, size, checksumType, payload);
 /// };
 ///
 /// } // namespace my_prot

doxygen/page_custom_size_layer.dox

@@ -215,7 +215,7 @@
 ///     >
 /// {
 ///     // Generate convenience access functions for various layers
-///     COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(id, size, payload);
+///     COMMS_FRAME_LAYERS_ACCESS_OUTER(id, size, payload);
 /// };
 ///
 /// } // namespace my_prot
@@ -321,7 +321,7 @@
 ///     >
 /// {
 ///     // Generate convenience access functions for various layers
-///     COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(size, id, flags, payload);
+///     COMMS_FRAME_LAYERS_ACCESS_OUTER(size, id, flags, payload);
 /// };
 ///
 /// } // namespace my_prot

doxygen/page_custom_sync_prefix_layer.dox

@@ -130,7 +130,7 @@
 ///     >
 /// {
 ///     // Generate convenience access functions for various layers
-///     COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(sync, size, size, payload);
+///     COMMS_FRAME_LAYERS_ACCESS_OUTER(sync, size, size, payload);
 /// };
 ///
 /// } // namespace my_prot

doxygen/page_custom_transport_value_layer.dox

@@ -225,7 +225,7 @@
 ///     >
 /// {
 ///     // Generate convenience access functions for various layers
-///     COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(size, size, versionFlags, payload);
+///     COMMS_FRAME_LAYERS_ACCESS_OUTER(size, size, versionFlags, payload);
 /// };
 ///
 /// } // namespace my_prot

doxygen/page_frame.dox

@@ -535,7 +535,7 @@
 /// Every protocol layer provides an ability to access the next one using
 /// @ref comms::frame::FrameLayerBase::nextLayer() "nextLayer()" member function.
 /// It is strongly recommended to generate convenience access functions using
-/// #COMMS_PROTOCOL_LAYERS_ACCESS() macro.
+/// #COMMS_FRAME_LAYERS_ACCESS() macro.
 /// @code
 /// template <
 ///     typename TMessage, // common interface class defined by the application
@@ -545,7 +545,7 @@
 /// struct Frame : public 
 ///     MySyncPrefix<TMessage, TInputMessages, TAllocationOptions> 
 /// {
-///     COMMS_PROTOCOL_LAYERS_ACCESS(payload, id, size, checksum, sync);
+///     COMMS_FRAME_LAYERS_ACCESS(payload, id, size, checksum, sync);
 /// };
 /// @endcode
 /// It is equivalent to having the following member function being defined:
@@ -591,14 +591,14 @@
 /// @endcode
 /// Please note the following:
 /// @li Every provided name is prefixed with @b layer_.
-/// @li The names inside the #COMMS_PROTOCOL_LAYERS_ACCESS() macro specify
+/// @li The names inside the #COMMS_FRAME_LAYERS_ACCESS() macro specify
 /// innermost layer first and outermost one last. There is a convenience 
-/// wrapper macro #COMMS_PROTOCOL_LAYERS_ACCESS_OUTER() which allows
+/// wrapper macro #COMMS_FRAME_LAYERS_ACCESS_OUTER() which allows
 /// listing in the opposite order (outermost first and innermost last).
 ///
 /// <b style="color:red">WARNING:</b> Some compilers, such as @b clang or earlier
 /// versions of @b gcc (v4.9 and earlier) may have problems compiling the 
-/// #COMMS_PROTOCOL_LAYERS_ACCESS() macro
+/// #COMMS_FRAME_LAYERS_ACCESS() macro
 /// even though it contains valid C++11 code. If the compilation failure 
 /// happens there is a need to define inner @b Base type which specifies exact type
 /// of the frame base class.
@@ -613,7 +613,7 @@
 /// {
 ///     using Base = MySyncPrefix<TMessage, TInputMessages, TAllocationOptions>;
 /// public:
-///     COMMS_PROTOCOL_LAYERS_ACCESS(payload, id, size, checksum, sync);
+///     COMMS_FRAME_LAYERS_ACCESS(payload, id, size, checksum, sync);
 /// };
 /// @endcode
 /// @b NOTE, that @b COMMS library also defines @b COMMS_MUST_DEFINE_BASE in
@@ -634,12 +634,12 @@
 ///     using Base = ...
 /// #endif
 /// public:
-///     COMMS_PROTOCOL_LAYERS_ACCESS(payload, id, size, checksum, sync);
+///     COMMS_FRAME_LAYERS_ACCESS(payload, id, size, checksum, sync);
 /// };
 /// @endcode
-/// Since **v5.2** the COMMS library defines #COMMS_PROTOCOL_LAYERS_NAMES() and
-/// #COMMS_PROTOCOL_LAYERS_NAMES_OUTER() macros they are similar to
-/// the #COMMS_PROTOCOL_LAYERS_NAMES() and #COMMS_PROTOCOL_LAYERS_NAMES_OUTER()
+/// Since **v5.2** the COMMS library defines #COMMS_FRAME_LAYERS_NAMES() and
+/// #COMMS_FRAME_LAYERS_NAMES_OUTER() macros they are similar to
+/// the #COMMS_FRAME_LAYERS_NAMES() and #COMMS_FRAME_LAYERS_NAMES_OUTER()
 /// respectively, but also provide aliases to the layer types. However usage of these
 /// macros requires inner **Base** type definition of the base class:
 /// @code
@@ -654,7 +654,7 @@
 ///     // Base type definition is a requirement
 ///     using Base = MySyncPrefix<TMessage, TInputMessages, TAllocationOptions>
 /// public:
-///     COMMS_PROTOCOL_LAYERS_NAMES(payload, id, size, checksum, sync);
+///     COMMS_FRAME_LAYERS_NAMES(payload, id, size, checksum, sync);
 /// };
 /// @endcode
 /// It is equivalent to having the following types and member function being defined:

doxygen/page_use_prot.dox

@@ -2238,7 +2238,7 @@
 /// struct Frame : public 
 ///     MySyncPrefix<TMessage, TInputMessages, TAllocationOptions> 
 /// {
-///     COMMS_PROTOCOL_LAYERS_ACCESS(...);
+///     COMMS_FRAME_LAYERS_ACCESS(...);
 /// };
 ///
 /// } // namespace my_protocol
@@ -2300,7 +2300,7 @@
 /// struct Frame : public 
 ///     MySyncPrefix<TMessage, TInputMessages, TOpt> 
 /// {
-///     COMMS_PROTOCOL_LAYERS_ACCESS(...);
+///     COMMS_FRAME_LAYERS_ACCESS(...);
 /// };
 ///
 /// } // namespace my_protocol
@@ -2574,7 +2574,7 @@
 /// one another. Access to the appropriate layer may be obtained using a 
 /// sequence of calls to @b nextLayer() member functions (see 
 /// @ref comms::frame::FrameLayerBase::nextLayer()). Alternatively, the frame
-/// definition is also expected to use #COMMS_PROTOCOL_LAYERS_ACCESS()
+/// definition is also expected to use #COMMS_FRAME_LAYERS_ACCESS()
 /// macro to generate a convenience access functions. For example
 /// @code
 /// namespace my_protocol
@@ -2588,7 +2588,7 @@
 /// struct Frame : public 
 ///     MySyncPrefix<TMessage, TInputMessages, TAllocationOptions> 
 /// {
-///     COMMS_PROTOCOL_LAYERS_ACCESS(payload, id, size, checksum, sync);
+///     COMMS_FRAME_LAYERS_ACCESS(payload, id, size, checksum, sync);
 /// };
 ///
 /// } // namespace my_protocol
@@ -3129,7 +3129,7 @@
 /// struct Frame : public 
 ///     MySizePrefix<TMessage, TInputMessages, TAllocationOptions> 
 /// {
-///     COMMS_PROTOCOL_LAYERS_ACCESS(payload, version, id, size);
+///     COMMS_FRAME_LAYERS_ACCESS(payload, version, id, size);
 /// };
 ///
 /// } // namespace my_protocol

include/comms/frame/FrameLayerBase.h

@@ -1662,48 +1662,48 @@ details::MsgPayloadRetriever<TIter> msgPayload(TIter& iter, std::size_t& len)
 ///     (@ref comms::frame::MsgDataLayer), while the last one
 ///     is the name for the outermost one.
 /// @related comms::frame::FrameLayerBase
-#define COMMS_PROTOCOL_LAYERS_ACCESS(...) \
+#define COMMS_FRAME_LAYERS_ACCESS(...) \
     COMMS_DO_ACCESS_LAYER_ACC_FUNC(__VA_ARGS__)
 
 /// @brief Provide names and convenience access functions to protocol
 ///     layers.
-/// @details Similar to #COMMS_PROTOCOL_LAYERS_ACCESS() but
+/// @details Similar to #COMMS_FRAME_LAYERS_ACCESS() but
 ///     defines "Layer_<name>" type names.
 /// @pre Requires definition of inner "Base" type aliasing the base class.
 /// @related comms::frame::FrameLayerBase
-#define COMMS_PROTOCOL_LAYERS_NAMES(...) \
+#define COMMS_FRAME_LAYERS_NAMES(...) \
     COMMS_DO_LAYER_TYPE_ALIAS(Base, __VA_ARGS__) \
     COMMS_DO_ACCESS_LAYER_ACC_FUNC(__VA_ARGS__)
 
 
-/// @brief Same as #COMMS_PROTOCOL_LAYERS_ACCESS()
+/// @brief Same as #COMMS_FRAME_LAYERS_ACCESS()
 /// @related comms::frame::FrameLayerBase
-#define COMMS_PROTOCOL_LAYERS_ACCESS_INNER(...) \
-    COMMS_PROTOCOL_LAYERS_ACCESS(__VA_ARGS__)
+#define COMMS_FRAME_LAYERS_ACCESS_INNER(...) \
+    COMMS_FRAME_LAYERS_ACCESS(__VA_ARGS__)
 
-/// @brief Same as #COMMS_PROTOCOL_LAYERS_NAMES()
+/// @brief Same as #COMMS_FRAME_LAYERS_NAMES()
 /// @related comms::frame::FrameLayerBase
-#define COMMS_PROTOCOL_LAYERS_NAMES_INNER(...) \
-    COMMS_PROTOCOL_LAYERS_NAMES(__VA_ARGS__)    
+#define COMMS_FRAME_LAYERS_NAMES_INNER(...) \
+    COMMS_FRAME_LAYERS_NAMES(__VA_ARGS__)    
 
 /// @brief Provide convenience access functions to protocol
 ///     layers.
-/// @details Similar to #COMMS_PROTOCOL_LAYERS_ACCESS(), but
+/// @details Similar to #COMMS_FRAME_LAYERS_ACCESS(), but
 ///     the arguments are expected to be in reverse order, i.e.
 ///     the first argument is the name of the outermost layer, while
 ///     the last one is the name for the innermost one
 ///     (@ref comms::frame::MsgDataLayer)
 /// @related comms::frame::FrameLayerBase
-#define COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(...) \
-    COMMS_PROTOCOL_LAYERS_ACCESS(COMMS_EXPAND(COMMS_REVERSE_MACRO_ARGS(__VA_ARGS__)))
+#define COMMS_FRAME_LAYERS_ACCESS_OUTER(...) \
+    COMMS_FRAME_LAYERS_ACCESS(COMMS_EXPAND(COMMS_REVERSE_MACRO_ARGS(__VA_ARGS__)))
 
 /// @brief Provide names and convenience access functions to protocol
 ///     layers.
-/// @details Similar to #COMMS_PROTOCOL_LAYERS_ACCESS_OUTER() but
+/// @details Similar to #COMMS_FRAME_LAYERS_ACCESS_OUTER() but
 ///     defines "Layer_<name>" type names.
 /// @pre Requires definition of inner "Base" type aliasing the base class.
 /// @related comms::frame::FrameLayerBase
-#define COMMS_PROTOCOL_LAYERS_NAMES_OUTER(...) \
-    COMMS_PROTOCOL_LAYERS_NAMES(COMMS_EXPAND(COMMS_REVERSE_MACRO_ARGS(__VA_ARGS__)))
+#define COMMS_FRAME_LAYERS_NAMES_OUTER(...) \
+    COMMS_FRAME_LAYERS_NAMES(COMMS_EXPAND(COMMS_REVERSE_MACRO_ARGS(__VA_ARGS__)))
 
 COMMS_MSVC_WARNING_POP

include/comms/protocol/ProtocolLayerBase.h

@@ -72,3 +72,27 @@ auto msgPayload(TIter& iter, std::size_t& len) -> decltype(comms::frame::msgPayl
 }  // namespace protocol
 
 }  // namespace comms
+
+/// @brief Same as #COMMS_FRAME_LAYERS_ACCESS()
+/// @deprecated Use #COMMS_FRAME_LAYERS_ACCESS() instead
+#define COMMS_PROTOCOL_LAYERS_ACCESS(...) COMMS_FRAME_LAYERS_ACCESS(__VA_ARGS__)
+
+/// @brief Same as #COMMS_FRAME_LAYERS_NAMES()
+/// @deprecated Use #COMMS_FRAME_LAYERS_NAMES() instead
+#define COMMS_PROTOCOL_LAYERS_NAMES(...) COMMS_FRAME_LAYERS_NAMES(__VA_ARGS__)
+
+/// @brief Same as #COMMS_FRAME_LAYERS_ACCESS_INNER()
+/// @deprecated Use #COMMS_FRAME_LAYERS_ACCESS_INNER() instead
+#define COMMS_PROTOCOL_LAYERS_ACCESS_INNER(...) COMMS_FRAME_LAYERS_ACCESS_INNER(__VA_ARGS__)
+
+/// @brief Same as #COMMS_FRAME_LAYERS_NAMES_INNER()
+/// @deprecated Use #COMMS_FRAME_LAYERS_NAMES_INNER() instead
+#define COMMS_PROTOCOL_LAYERS_NAMES_INNER(...) COMMS_FRAME_LAYERS_NAMES_INNER(__VA_ARGS__)    
+
+/// @brief Same as #COMMS_FRAME_LAYERS_ACCESS_OUTER()
+/// @deprecated Use #COMMS_FRAME_LAYERS_ACCESS_OUTER() instead
+#define COMMS_PROTOCOL_LAYERS_ACCESS_OUTER(...) COMMS_FRAME_LAYERS_ACCESS_OUTER(__VA_ARGS__)
+
+/// @brief Same as #COMMS_FRAME_LAYERS_NAMES_OUTER()
+/// @deprecated Use #COMMS_FRAME_LAYERS_NAMES_OUTER() instead
+#define COMMS_PROTOCOL_LAYERS_NAMES_OUTER(...) COMMS_FRAME_LAYERS_NAMES_OUTER(__VA_ARGS__)

include/comms/version.h

@@ -17,7 +17,7 @@
 #define COMMS_MINOR_VERSION 4U
 
 /// @brief Patch level of the library
-#define COMMS_PATCH_VERSION 0U
+#define COMMS_PATCH_VERSION 1U
 
 /// @brief Macro to create numeric version as single unsigned number
 #define COMMS_MAKE_VERSION(major_, minor_, patch_) \

test/ChecksumLayer.th

@@ -200,7 +200,7 @@ private:
                 >
             >;
     public:
-        COMMS_PROTOCOL_LAYERS_NAMES_OUTER(sync, checksum, size, id, payload);
+        COMMS_FRAME_LAYERS_NAMES_OUTER(sync, checksum, size, id, payload);
     };
 
     template <typename TSyncField, typename TChecksumField, typename TSizeField, typename TIdField, typename TMessage>
@@ -260,7 +260,7 @@ private:
                 >
             >;
     public:
-        COMMS_PROTOCOL_LAYERS_NAMES(payload, id, size, checksum, sync);
+        COMMS_FRAME_LAYERS_NAMES(payload, id, size, checksum, sync);
         static_assert(comms::frame::isSyncPrefixLayer<Layer_sync>(), "Invalid type");
         static_assert(comms::frame::isChecksumPrefixLayer<Layer_checksum>(), "Invalid type");
         static_assert(comms::frame::isMsgSizeLayer<Layer_size>(), "Invalid type");