libjmmcg  build_2783
A C++ library containing an eclectic mix of useful, advanced components.
isimud::exchanges::BATSBOE::common::Logout Struct Reference

#include <messages.hpp>

Inheritance diagram for isimud::exchanges::BATSBOE::common::Logout:
[legend]
Collaboration diagram for isimud::exchanges::BATSBOE::common::Logout:
[legend]

Public Types

enum  : std::size_t { header_t_size =sizeof(Header_t) }
 
using Header_t = Header< MsgType, MsgType::Logout >
 
- Public Types inherited from isimud::exchanges::BATSBOE::common::Header< MsgType, MsgType::Logout >
enum  
 
enum  
 
using MsgType_t = MsgType
 
using MsgTypes_t = common::MsgType_t
 

Public Member Functions

 Logout () noexcept(true) FORCE_INLINE
 
 Logout (uint32_t seqNum, LogoutReason lr) noexcept(true) FORCE_INLINE
 
- Public Member Functions inherited from isimud::exchanges::BATSBOE::common::Header< MsgType, MsgType::Logout >
 Header (std::size_t l) noexcept(true) FORCE_INLINE
 
 Header (std::size_t l, std::uint32_t seqNumber) noexcept(true) FORCE_INLINE
 
const MsgType_t type () const noexcept(true)
 
std::uint16_t length () const noexcept(true)
 The actual, not the foolish BATSBOE-specified, length which excludes the start_of_message field. More...
 
bool is_valid () const noexcept(true)
 

Public Attributes

LogoutReason logoutReason
 
LogoutReasonText_t logoutReasonText
 
uint32_t lastReceivedSequenceNumber
 
const uint8_t numberOfUnits =0
 
- Public Attributes inherited from isimud::exchanges::BATSBOE::common::Header< MsgType, MsgType::Logout >
enum isimud::exchanges::BATSBOE::common::Header:: { ... }  __attribute__
 
const std::uint16_t start_of_message
 
const MsgType_t type_
 
const std::uint8_t matchingUnit
 
const std::uint32_t sequenceNumber
 

Additional Inherited Members

- Protected Member Functions inherited from isimud::exchanges::BATSBOE::common::Header< MsgType, MsgType::Logout >
 ~Header () noexcept(true)=default
 
- Protected Attributes inherited from isimud::exchanges::BATSBOE::common::Header< MsgType, MsgType::Logout >
std::uint16_t length_
 

Detailed Description

Section: "3.2.2 Logout"

Definition at line 283 of file messages.hpp.

Member Typedef Documentation

◆ Header_t

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : std::size_t
Enumerator
header_t_size 

Definition at line 285 of file messages.hpp.

Constructor & Destructor Documentation

◆ Logout() [1/2]

isimud::exchanges::BATSBOE::common::Logout::Logout ( )
inlinenoexcept

Definition at line 165 of file messages_impl.hpp.

◆ Logout() [2/2]

isimud::exchanges::BATSBOE::common::Logout::Logout ( uint32_t  seqNum,
LogoutReason  lr 
)
inlinenoexcept

Member Data Documentation

◆ lastReceivedSequenceNumber

uint32_t isimud::exchanges::BATSBOE::common::Logout::lastReceivedSequenceNumber

Definition at line 291 of file messages.hpp.

◆ logoutReason

LogoutReason isimud::exchanges::BATSBOE::common::Logout::logoutReason

Definition at line 289 of file messages.hpp.

◆ logoutReasonText

LogoutReasonText_t isimud::exchanges::BATSBOE::common::Logout::logoutReasonText

Definition at line 290 of file messages.hpp.

◆ numberOfUnits

const uint8_t isimud::exchanges::BATSBOE::common::Logout::numberOfUnits =0

Definition at line 292 of file messages.hpp.


The documentation for this struct was generated from the following files: