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

#include <messages.hpp>

Inheritance diagram for isimud::exchanges::MIT::common::LogoutRequest:
[legend]
Collaboration diagram for isimud::exchanges::MIT::common::LogoutRequest:
[legend]

Public Types

enum  : MsgType_t { static_type =static_cast<MsgType_t>(AdminMsgType::LogoutRequest) }
 
enum  : std::size_t { header_t_size =sizeof(Header_t) }
 
using Header_t = Header
 
- Public Types inherited from isimud::exchanges::MIT::common::Header
enum  : bool { has_static_size =true }
 
using ClientOrderID_t = common::ClientOrderID_t
 
using OrderID_t = common::OrderID_t
 
using MsgTypes_t = common::MsgType_t
 

Public Member Functions

constexpr LogoutRequest () noexcept(true) FORCE_INLINE
 
constexpr LogoutRequest (Reason_t r) noexcept(true) FORCE_INLINE
 
constexpr LogoutRequest (logoff_args_t const &a) noexcept(true) FORCE_INLINE
 
template<class SrcMsg >
constexpr __stdcall LogoutRequest (SrcMsg const &msg, Reason_t r) noexcept(true)=deleteFORCE_INLINE
 Create a message from the source message. More...
 
const Reason_treason () const noexcept(true)
 
- Public Member Functions inherited from isimud::exchanges::MIT::common::Header
MsgType_t type () const noexcept(true)
 
std::uint16_t length () const noexcept(true)
 
bool is_valid () const noexcept(true)
 

Public Attributes

const Reason_t reason_
 
- Public Attributes inherited from isimud::exchanges::MIT::common::Header
enum isimud::exchanges::MIT::common::Header:: { ... }  __attribute__
 
const std::int8_t start_of_message =2
 
const std::int16_t length_
 
const MsgType_t type_
 

Additional Inherited Members

- Protected Member Functions inherited from isimud::exchanges::MIT::common::Header
template<class MsgT >
constexpr Header (MsgT const *) noexcept(true) FORCE_INLINE
 

Detailed Description

Section: "8.3.3 Logout"

Definition at line 215 of file messages.hpp.

Member Typedef Documentation

◆ Header_t

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : MsgType_t
Enumerator
static_type 

Definition at line 217 of file messages.hpp.

◆ anonymous enum

anonymous enum : std::size_t
Enumerator
header_t_size 

Definition at line 220 of file messages.hpp.

Constructor & Destructor Documentation

◆ LogoutRequest() [1/4]

constexpr isimud::exchanges::MIT::common::LogoutRequest::LogoutRequest ( )
inlineexplicitconstexprnoexcept

Definition at line 131 of file messages_impl.hpp.

◆ LogoutRequest() [2/4]

constexpr isimud::exchanges::MIT::common::LogoutRequest::LogoutRequest ( Reason_t  r)
inlineexplicitconstexprnoexcept

Definition at line 137 of file messages_impl.hpp.

◆ LogoutRequest() [3/4]

constexpr isimud::exchanges::MIT::common::LogoutRequest::LogoutRequest ( logoff_args_t const &  a)
inlineexplicitconstexprnoexcept

Definition at line 142 of file messages_impl.hpp.

◆ LogoutRequest() [4/4]

template<class SrcMsg >
constexpr __stdcall isimud::exchanges::MIT::common::LogoutRequest::LogoutRequest ( SrcMsg const &  msg,
Reason_t  r 
)
explicitconstexprdeletenoexcept

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.

Member Function Documentation

◆ reason()

const Reason_t& isimud::exchanges::MIT::common::LogoutRequest::reason ( ) const
inlinenoexcept

Definition at line 239 of file messages.hpp.

Member Data Documentation

◆ reason_

const Reason_t isimud::exchanges::MIT::common::LogoutRequest::reason_

Definition at line 224 of file messages.hpp.


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