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

Public Member Functions

bool valid () const noexcept
 operator bool () const noexcept

Static Public Member Functions

static BgwCredentials create (Messaging::IPReport::UsersEntry entry)

Public Attributes

std::string host
Port port {}
std::string ipSessionToken

Detailed Description

Definition at line 33 of file BgwCredentials.h.

Member Function Documentation

◆ create()

BgwCredentials create ( Messaging::IPReport::UsersEntry entry)
inlinestatic

Creates BgwCredentials from the given IPReport::UsersEntry instance.

Definition at line 58 of file BgwCredentials.h.

◆ operator bool()

operator bool ( ) const
inlineexplicitnoexcept

Definition at line 52 of file BgwCredentials.h.

◆ valid()

bool valid ( ) const
inlinenoexcept

Checks whether all required fields are present and usable.

Definition at line 46 of file BgwCredentials.h.

Member Data Documentation

◆ host

std::string host

IP address of the gateway endpoint.

Definition at line 36 of file BgwCredentials.h.

◆ ipSessionToken

std::string ipSessionToken

ipSessionToken from Binary Utility Service Gateway (BUS).

Required for Binary Order Gateway (BGW) logons requests.

Definition at line 43 of file BgwCredentials.h.

◆ port

Port port {}

Network port number of the gateway endpoint.

Definition at line 39 of file BgwCredentials.h.