|
84 | 84 | /// { |
85 | 85 | /// |
86 | 86 | /// class Message : public comms::Message |
| 87 | +/// { |
87 | 88 | /// // comms::Field class with the same endian option. |
88 | 89 | /// // Can (and should) be provided as a base class to all the |
89 | 90 | /// // fields. |
|
2232 | 2233 | /// template < |
2233 | 2234 | /// typename TMessage, // common interface class defined by the application |
2234 | 2235 | /// 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 |
2237 | 2237 | /// > |
2238 | 2238 | /// struct ProtocolStack : public |
2239 | | -/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions> |
| 2239 | +/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions> |
2240 | 2240 | /// { |
2241 | 2241 | /// COMMS_PROTOCOL_LAYERS_ACCESS(...); |
2242 | 2242 | /// }; |
|
2259 | 2259 | /// possible to modify such behaviour by using @ref comms::option::app::InPlaceAllocation |
2260 | 2260 | /// option. It will be explained in more details further below. |
2261 | 2261 | /// |
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 | | -/// |
2266 | 2262 | /// @b NOTE, that @b ProtocolStack definition is actually an alias to one |
2267 | 2263 | /// of the classes from @ref comms::protocol namespace. To get a detailed |
2268 | 2264 | /// information on available public API please reference to one of them, for |
2269 | 2265 | /// example @ref comms::protocol::SyncPrefixLayer. |
2270 | 2266 | /// |
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) |
2272 | 2268 | /// are defined inside the recommended @b DefaultOptions structure and be |
2273 | 2269 | /// passed to the layers definitions themselves. Such approach is undertaken by |
2274 | 2270 | /// the **commsdsl2comms** code generator application from the |
|
2565 | 2561 | /// The layer class that is responsible to read/write payload data |
2566 | 2562 | /// (see @ref comms::protocol::MsgDataLayer) uses @ref comms::field::ArrayList |
2567 | 2563 | /// 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. |
2570 | 2565 | /// In case the the input / output buffer outlives the @b AllFields |
2571 | 2566 | /// object, consider passing @ref comms::option::app::OrigDataView option as the |
2572 | 2567 | /// fourth template parameter to @b ProtocolStack definition, which will pass it to |
|
2588 | 2583 | /// template < |
2589 | 2584 | /// typename TMessage, // common interface class defined by the application |
2590 | 2585 | /// 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 |
2593 | 2587 | /// > |
2594 | 2588 | /// struct ProtocolStack : public |
2595 | | -/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions> |
| 2589 | +/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions> |
2596 | 2590 | /// { |
2597 | 2591 | /// COMMS_PROTOCOL_LAYERS_ACCESS(payload, id, size, checksum, sync); |
2598 | 2592 | /// }; |
|
2606 | 2600 | /// template < |
2607 | 2601 | /// typename TMessage, // common interface class defined by the application |
2608 | 2602 | /// 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 |
2611 | 2604 | /// > |
2612 | 2605 | /// struct ProtocolStack : public |
2613 | | -/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions> |
| 2606 | +/// MySyncPrefix<TMessage, TInputMessages, TAllocationOptions> |
2614 | 2607 | /// { |
2615 | 2608 | /// // Access to PAYLOAD layer |
2616 | 2609 | /// decltype(auto) layer_payload(); |
|
3131 | 3124 | /// template < |
3132 | 3125 | /// typename TMessage, // common interface class defined by the application |
3133 | 3126 | /// 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 |
3136 | 3128 | /// > |
3137 | 3129 | /// struct ProtocolStack : public |
3138 | | -/// MySizePrefix<TMessage, TInputMessages, TAllocationOptions, TPayloadOptions> |
| 3130 | +/// MySizePrefix<TMessage, TInputMessages, TAllocationOptions> |
3139 | 3131 | /// { |
3140 | 3132 | /// COMMS_PROTOCOL_LAYERS_ACCESS(payload, version, id, size); |
3141 | 3133 | /// }; |
|
0 commit comments