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

#include <messages.hpp>

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

Public Types

enum  : MsgType_t { static_type =static_cast<MsgType_t>(AdminMsgType::LogonRequest) }
 
enum  : std::size_t { header_t_size =sizeof(Header_t) }
 
using Header_t = Header
 
using logon_args_t = common::logon_args_t
 
- 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 LogonRequest (const logon_args_t::UserName_t &UN, const logon_args_t::Password_t &P, const logon_args_t::Password_t &NP) noexcept(true) FORCE_INLINE
 
constexpr LogonRequest (logon_args_t const &a) noexcept(true) FORCE_INLINE
 
template<class SrcMsg >
__stdcall LogonRequest (SrcMsg const &msg) noexcept(true)=deleteFORCE_INLINE
 Create a message from the source message. More...
 
- 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 logon_args_t::UserName_t userName
 
const logon_args_t::Password_t password
 
const logon_args_t::Password_t newPassword
 
const std::uint8_t messageVersion =1
 
- 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.1 Logon"

Definition at line 155 of file messages.hpp.

Member Typedef Documentation

◆ Header_t

◆ logon_args_t

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : MsgType_t
Enumerator
static_type 

Definition at line 158 of file messages.hpp.

◆ anonymous enum

anonymous enum : std::size_t
Enumerator
header_t_size 

Definition at line 161 of file messages.hpp.

Constructor & Destructor Documentation

◆ LogonRequest() [1/3]

constexpr isimud::exchanges::MIT::common::LogonRequest::LogonRequest ( const logon_args_t::UserName_t UN,
const logon_args_t::Password_t P,
const logon_args_t::Password_t NP 
)
inlineconstexprnoexcept

Definition at line 97 of file messages_impl.hpp.

◆ LogonRequest() [2/3]

constexpr isimud::exchanges::MIT::common::LogonRequest::LogonRequest ( logon_args_t const &  a)
inlineexplicitconstexprnoexcept

Definition at line 102 of file messages_impl.hpp.

◆ LogonRequest() [3/3]

template<class SrcMsg >
__stdcall isimud::exchanges::MIT::common::LogonRequest::LogonRequest ( SrcMsg const &  msg)
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.

Member Data Documentation

◆ messageVersion

const std::uint8_t isimud::exchanges::MIT::common::LogonRequest::messageVersion =1

Definition at line 168 of file messages.hpp.

◆ newPassword

const logon_args_t::Password_t isimud::exchanges::MIT::common::LogonRequest::newPassword

Definition at line 167 of file messages.hpp.

◆ password

const logon_args_t::Password_t isimud::exchanges::MIT::common::LogonRequest::password

Definition at line 166 of file messages.hpp.

◆ userName

const logon_args_t::UserName_t isimud::exchanges::MIT::common::LogonRequest::userName

Definition at line 165 of file messages.hpp.


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