Skip to content

Commit 87497f3

Browse files
committed
Release v5.3
2 parents e7394d2 + c932a1f commit 87497f3

189 files changed

Lines changed: 946 additions & 388 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/actions_build.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
name: Github Actions Build
22

3-
on: [push]
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
tags-ignore:
8+
- '**'
49

510
jobs:
611

doxygen/page_prot_stack.dox

Lines changed: 45 additions & 65 deletions
Large diffs are not rendered by default.

doxygen/page_use_prot.dox

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
/// {
8585
///
8686
/// class Message : public comms::Message
87+
/// {
8788
/// // comms::Field class with the same endian option.
8889
/// // Can (and should) be provided as a base class to all the
8990
/// // fields.
@@ -2232,11 +2233,10 @@
22322233
/// template <
22332234
/// typename TMessage, // common interface class defined by the application
22342235
/// typename TInputMessages = AllMessages<TMessage>, // Input messages that need to be recognised
2235-
/// typename TAllocationOptions = comms::option::app::EmptyOption, // Extra options for comms::protocol::MsgIdLayer
2236-
/// typename TPayloadOptions = comms::option::app::EmptyOption // Extra options for payload storage
2236+
/// typename TAllocationOptions = comms::option::app::EmptyOption // Extra options for comms::protocol::MsgIdLayer
22372237
/// >
22382238
/// struct ProtocolStack : public
2239-
/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions>
2239+
/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions>
22402240
/// {
22412241
/// COMMS_PROTOCOL_LAYERS_ACCESS(...);
22422242
/// };
@@ -2259,16 +2259,12 @@
22592259
/// possible to modify such behaviour by using @ref comms::option::app::InPlaceAllocation
22602260
/// option. It will be explained in more details further below.
22612261
///
2262-
/// The fourth template parameter (@b TPayloadOptions) is irrelevant in
2263-
/// most cases. It has a meaning only when transport wrapping values are cached
2264-
/// for further analysis. It will also be explained in more details further below.
2265-
///
22662262
/// @b NOTE, that @b ProtocolStack definition is actually an alias to one
22672263
/// of the classes from @ref comms::protocol namespace. To get a detailed
22682264
/// information on available public API please reference to one of them, for
22692265
/// example @ref comms::protocol::SyncPrefixLayer.
22702266
///
2271-
/// It may also happen, that the extra options (@b TAllocationOptions and @b TPayloadOptions)
2267+
/// It may also happen, that the extra options (@b TAllocationOptions)
22722268
/// are defined inside the recommended @b DefaultOptions structure and be
22732269
/// passed to the layers definitions themselves. Such approach is undertaken by
22742270
/// the **commsdsl2comms** code generator application from the
@@ -2565,8 +2561,7 @@
25652561
/// The layer class that is responsible to read/write payload data
25662562
/// (see @ref comms::protocol::MsgDataLayer) uses @ref comms::field::ArrayList
25672563
/// to define a field that will store the payload when "caching" operations are
2568-
/// performed. That's where the fourth template parameter (@b TPayloadOptions)
2569-
/// to @b ProtocolStack definition comes in play.
2564+
/// performed.
25702565
/// In case the the input / output buffer outlives the @b AllFields
25712566
/// object, consider passing @ref comms::option::app::OrigDataView option as the
25722567
/// fourth template parameter to @b ProtocolStack definition, which will pass it to
@@ -2588,11 +2583,10 @@
25882583
/// template <
25892584
/// typename TMessage, // common interface class defined by the application
25902585
/// typename TInputMessages = AllMessages<TMessage>, // Input messages that need to be recognised
2591-
/// typename TAllocationOptions = comms::option::app::EmptyOption, // Extra options for MsgIdLayer
2592-
/// typename TPayloadOptions = comms::option::app::EmptyOption // Extra options for payload storage
2586+
/// typename TAllocationOptions = comms::option::app::EmptyOption // Extra options for MsgIdLayer
25932587
/// >
25942588
/// struct ProtocolStack : public
2595-
/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions>
2589+
/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions>
25962590
/// {
25972591
/// COMMS_PROTOCOL_LAYERS_ACCESS(payload, id, size, checksum, sync);
25982592
/// };
@@ -2606,11 +2600,10 @@
26062600
/// template <
26072601
/// typename TMessage, // common interface class defined by the application
26082602
/// typename TInputMessages = AllMessages<TMessage>, // Input messages that need to be recognised
2609-
/// typename TAllocationOptions = comms::option::app::EmptyOption, // Extra options for MsgIdLayer
2610-
/// typename TPayloadOptions = comms::option::app::EmptyOption // Extra options for payload storage
2603+
/// typename TAllocationOptions = comms::option::app::EmptyOption // Extra options for MsgIdLayer
26112604
/// >
26122605
/// struct ProtocolStack : public
2613-
/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions>
2606+
/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions>
26142607
/// {
26152608
/// // Access to PAYLOAD layer
26162609
/// decltype(auto) layer_payload();
@@ -3131,11 +3124,10 @@
31313124
/// template <
31323125
/// typename TMessage, // common interface class defined by the application
31333126
/// typename TInputMessages = AllMessages<TMessage>, // Input messages that need to be recognised
3134-
/// typename TAllocationOptions = comms::option::app::EmptyOption, // Extra options for MsgIdLayer
3135-
/// typename TPayloadOptions = comms::option::app::EmptyOption // Extra options for payload storage
3127+
/// typename TAllocationOptions = comms::option::app::EmptyOption // Extra options for MsgIdLayer
31363128
/// >
31373129
/// struct ProtocolStack : public
3138-
/// MySizePrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions>
3130+
/// MySizePrefix<TMessage, TInputMessages, TAllocationOptions>
31393131
/// {
31403132
/// COMMS_PROTOCOL_LAYERS_ACCESS(payload, version, id, size);
31413133
/// };

include/comms/Assert.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this

include/comms/CompileControl.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2015 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2015 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this

include/comms/EmptyHandler.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this

include/comms/ErrorStatus.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this

include/comms/Field.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -111,6 +111,13 @@ class Field : public details::FieldBase<TOptions...>
111111
return false;
112112
}
113113

114+
/// @brief Check of whether the field class defines @b name() function
115+
/// @return Always @b false
116+
static constexpr bool hasName()
117+
{
118+
return false;
119+
}
120+
114121
protected:
115122
/// @brief Write data into the output buffer.
116123
/// @details Use this function to write data to the the buffer

include/comms/GenericHandler.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this

include/comms/GenericMessage.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//
2-
// Copyright 2017 - 2024 (C). Alex Robenko. All rights reserved.
2+
// Copyright 2017 - 2025 (C). Alex Robenko. All rights reserved.
33
//
44
// This Source Code Form is subject to the terms of the Mozilla Public
55
// License, v. 2.0. If a copy of the MPL was not distributed with this

0 commit comments

Comments
 (0)