OnixS C++ ICE Binary Order Entry Handler 1.0.0
API Documentation
Loading...
Searching...
No Matches
IPReport::UsersEntry Struct Reference

Public Types

typedef SbeGroupEntry< GroupSizeEncoding::BlockLengthBase
typedef UsersEntry ThisType
Public Types inherited from SbeGroupEntry< GroupSizeEncoding::BlockLength >
typedef GroupSizeEncoding::BlockLength BlockLength

Public Member Functions

 UsersEntry (void *data, EncodedLength length, SchemaVersion version)
ThisTyperesetVariableFields () noexcept
ThisTypereset () noexcept
auto userId () const noexcept
ThisTypeuserId (StrRef value) noexcept
auto success () const noexcept
ThisTypesuccess (BooleanEnum value) noexcept
ThisTypesuccess (NullOpt) noexcept
auto ipAddress () const noexcept
ThisTypeipAddress (StrRef value) noexcept
ThisTypeipAddress (NullOpt) noexcept
auto port () const noexcept
ThisTypeport (Int16NULL value) noexcept
ThisTypeport (NullOpt) noexcept
auto ipSessionToken () const noexcept
ThisTypeipSessionToken (StrRef value) noexcept
ThisTypeipSessionToken (NullOpt) noexcept
Public Member Functions inherited from SbeGroupEntry< GroupSizeEncoding::BlockLength >
 SbeGroupEntry ()
 SbeGroupEntry (void *encoded, BlockLength size, SchemaVersion version)
bool valid () const noexcept
const void * encoded () const noexcept
void * encoded () noexcept
const void * block () const noexcept
void * block () noexcept
BlockLength blockLength () const noexcept
SchemaVersion version () const noexcept
Public Member Functions inherited from SbeFields< Container, BlockLength >
ONIXS_ICEBOE_FORCEINLINE Container & container () noexcept
void zeroPaddingBytes (BlockLength offset) noexcept
template<class FieldValue>
ONIXS_ICEBOE_FORCEINLINE void setOrdinary (BlockLength offset, FieldValue value) noexcept
template<class FieldValue>
ONIXS_ICEBOE_FORCEINLINE void setOrdinary (BlockLength offset, FieldValue value, SchemaVersion since)
template<class Enumeration>
ONIXS_ICEBOE_FORCEINLINE void setEnumeration (BlockLength offset, Enumeration value) noexcept
template<class Enumeration>
ONIXS_ICEBOE_FORCEINLINE void setEnumeration (BlockLength offset, Enumeration value, SchemaVersion since)
template<BlockLength Size>
ONIXS_ICEBOE_FORCEINLINE void setFixedStr (BlockLength offset, StrRef value) noexcept
template<BlockLength Size>
ONIXS_ICEBOE_FORCEINLINE void setFixedStr (BlockLength offset, StrRef value, SchemaVersion since)

Static Public Member Functions

static constexpr BlockLength blockLength (SchemaVersion version) noexcept
static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
static constexpr StrRef className () noexcept

Additional Inherited Members

Protected Member Functions inherited from SbeFields< Container, BlockLength >
 SbeFields ()=default
 ~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Container, BlockLength >
 BinaryBlock ()=default
 ~BinaryBlock ()=default
template<typename Value>
ONIXS_ICEBOE_FORCEINLINE Value ordinary (BlockLength offset) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if< isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if< isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename Enumeration>
ONIXS_ICEBOE_FORCEINLINE Enumeration enumeration (BlockLength offset) const noexcept
template<typename Enumeration, typename NullValue>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalEnumeration< Enumeration, NullValue > enumeration (BlockLength offset, OptionalTag) const noexcept
template<typename Enumeration, typename NullValue>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalEnumeration< Enumeration, NullValue > enumeration (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<BlockLength Length>
ONIXS_ICEBOE_FORCEINLINE StrRef fixedStr (BlockLength offset) const noexcept
template<BlockLength Length>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalStr fixedStr (BlockLength offset, OptionalTag) const noexcept
template<BlockLength Length>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalStr fixedStr (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename Value>
ONIXS_ICEBOE_FORCEINLINE Value decimal (BlockLength offset) const noexcept
template<typename NullValue>
SbeOptional< typename NullValue::Value, NullValue > ONIXS_ICEBOE_FORCEINLINE decimal (BlockLength offset, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE SbeOptional< typename NullValue::Value, NullValue > decimal (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename NullValue, typename Callable>
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptionalConverted< decltype(std::declval< Callable >()(std::declval< typenameArgType< Callable >::type >()))> >::type convertible (BlockLength offset, OptionalTag) const noexcept(noexcept(Callable::Nothrow))
template<typename Callable>
ONIXS_ICEBOE_FORCEINLINE auto convertible (BlockLength offset) const noexcept(noexcept(Callable::Nothrow)) -> decltype(std::declval< Callable >()(std::declval< typename ArgType< Callable >::type >()))
Protected Member Functions inherited from BinaryBlockBase
 ~BinaryBlockBase ()=default

Detailed Description

Entry of UsersEntry repeating group.

Definition at line 8486 of file Messages.h.

Member Typedef Documentation

◆ Base

Base class type.

Definition at line 8498 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 8501 of file Messages.h.

Constructor & Destructor Documentation

◆ UsersEntry()

UsersEntry ( void * data,
EncodedLength length,
SchemaVersion version )
inline

Initializes instance of given version over given memory block.

Definition at line 8505 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept
Returns
size of entry body in bytes for given version of message template.

Definition at line 8665 of file Messages.h.

◆ className()

constexpr StrRef className ( )
inlinestaticconstexprnoexcept

Entity class name.

Definition at line 8685 of file Messages.h.

◆ ipAddress() [1/3]

auto ipAddress ( ) const
inlinenoexcept

Provides access to ipAddress field.

Definition at line 8578 of file Messages.h.

◆ ipAddress() [2/3]

ThisType & ipAddress ( NullOpt )
inlinenoexcept

Definition at line 8596 of file Messages.h.

◆ ipAddress() [3/3]

ThisType & ipAddress ( StrRef value)
inlinenoexcept

Provides access to ipAddress field.

Definition at line 8587 of file Messages.h.

◆ ipSessionToken() [1/3]

auto ipSessionToken ( ) const
inlinenoexcept

ipSessionToken for the Gateway ID for assigned ipAddress and port for use in Binary Order Gateway LogonRequests.

Definition at line 8634 of file Messages.h.

◆ ipSessionToken() [2/3]

ThisType & ipSessionToken ( NullOpt )
inlinenoexcept

Definition at line 8653 of file Messages.h.

◆ ipSessionToken() [3/3]

ThisType & ipSessionToken ( StrRef value)
inlinenoexcept

ipSessionToken for the Gateway ID for assigned ipAddress and port for use in Binary Order Gateway LogonRequests.

Definition at line 8644 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept
Returns
minimal size of entry body in bytes for given version of message template.

Definition at line 8675 of file Messages.h.

◆ port() [1/3]

auto port ( ) const
inlinenoexcept

int16NULL.

Definition at line 8607 of file Messages.h.

◆ port() [2/3]

ThisType & port ( Int16NULL value)
inlinenoexcept

int16NULL.

Definition at line 8615 of file Messages.h.

◆ port() [3/3]

ThisType & port ( NullOpt )
inlinenoexcept

Definition at line 8623 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 8519 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 8513 of file Messages.h.

◆ success() [1/3]

auto success ( ) const
inlinenoexcept

uint8NULL.

Definition at line 8552 of file Messages.h.

◆ success() [2/3]

ThisType & success ( BooleanEnum value)
inlinenoexcept

uint8NULL.

Definition at line 8560 of file Messages.h.

◆ success() [3/3]

ThisType & success ( NullOpt )
inlinenoexcept

Definition at line 8568 of file Messages.h.

◆ userId() [1/2]

auto userId ( ) const
inlinenoexcept

Provides access to userID field.

Definition at line 8532 of file Messages.h.

◆ userId() [2/2]

ThisType & userId ( StrRef value)
inlinenoexcept

Provides access to userID field.

Definition at line 8541 of file Messages.h.