libjmmcg  build_2176
A C++ library containing an eclectic mix of useful, advanced components.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | List of all members
jmmcg::exchanges::BATSBOE::common::ClientHeartbeat Struct Reference

#include <messages.hpp>

Inheritance diagram for jmmcg::exchanges::BATSBOE::common::ClientHeartbeat:
[legend]
Collaboration diagram for jmmcg::exchanges::BATSBOE::common::ClientHeartbeat:
[legend]

Public Types

enum  : std::size_t { header_t_size =sizeof(Header_t) }
 
enum  : uint32_t { seq_num =0 }
 
using Header_t = Header< MsgType, MsgType::ClientHeartbeat >
 
- Public Types inherited from jmmcg::exchanges::BATSBOE::common::Header< MsgType, MsgType::ClientHeartbeat >
enum  
 
enum  
 
using MsgType_t = MsgType
 

Public Member Functions

 ClientHeartbeat (uint32_t seqNum) noexcept(true) FORCE_INLINE
 
template<class SrcMsg >
__stdcall ClientHeartbeat (SrcMsg const &msg, uint32_t seqNum) noexcept(true)=deleteFORCE_INLINE
 Create a message from the source message. More...
 
- Public Member Functions inherited from jmmcg::exchanges::BATSBOE::common::Header< MsgType, MsgType::ClientHeartbeat >
 Header (std::size_t l) noexcept(true) FORCE_INLINE
 
 Header (std::size_t l, uint32_t seqNumber) noexcept(true) FORCE_INLINE
 
const MsgType_t type () const noexcept(true)
 
uint16_t length () const noexcept(true)
 The actual, not the foolish BATSBOE-specified, length which excludes the start_of_message field. More...
 

Additional Inherited Members

- Public Attributes inherited from jmmcg::exchanges::BATSBOE::common::Header< MsgType, MsgType::ClientHeartbeat >
enum
jmmcg::exchanges::BATSBOE::common::Header:: { ... }  		__attribute__
 
const uint16_t start_of_message
 
const MsgType_t type_
 
const uint8_t matchingUnit
 
const uint32_t sequenceNumber
 
- Protected Member Functions inherited from jmmcg::exchanges::BATSBOE::common::Header< MsgType, MsgType::ClientHeartbeat >
 ~Header () noexcept(true)=default
 
- Protected Attributes inherited from jmmcg::exchanges::BATSBOE::common::Header< MsgType, MsgType::ClientHeartbeat >
uint16_t length_
 

Detailed Description

Section: "3.1.3 Client Heartbeat" & "2.4 Heartbeats".

Definition at line 158 of file messages.hpp.

Member Typedef Documentation

using jmmcg::exchanges::BATSBOE::common::ClientHeartbeat::Header_t = Header<MsgType, MsgType::ClientHeartbeat>

Definition at line 159 of file messages.hpp.

Member Enumeration Documentation

anonymous enum : std::size_t
Enumerator
header_t_size 

Definition at line 160 of file messages.hpp.

anonymous enum : uint32_t
Enumerator
seq_num 

Definition at line 163 of file messages.hpp.

Constructor & Destructor Documentation

jmmcg::exchanges::BATSBOE::common::ClientHeartbeat::ClientHeartbeat ( uint32_t  seqNum)
inlineexplicitnoexcept

Definition at line 65 of file messages_impl.hpp.

template<class SrcMsg >
__stdcall jmmcg::exchanges::BATSBOE::common::ClientHeartbeat::ClientHeartbeat ( SrcMsg const &  msg,
uint32_t  seqNum 
)
explicitdeletenoexcept

Create a message from the source message.

If an error is generated, then this function will need to be specialised for the particular Msg-type.

Parameters
msgThe source message from which the target message should be created.
The documentation for this struct was generated from the following files: