Logon Class Reference

Logon. More...

Public Member Functions
MessageType::Enum	type () const
	Message type. More...
void	validate () const
	Validates message data by checking length limits for strings. More...
std::string	toString () const
	Returns string representation. More...
	Logon ()
	Default constructor. More...
Public Member Functions inherited from Message
SerializedMessage	toSerialized () const
	Returns serialized representation. More...
virtual	~Message ()
	Destructor. More...

Public Attributes
std::string	userId
	Fixed 8 byte String field. More...
std::string	password
	Fixed 10 byte String field. More...
UInt32	nextExpectedSequenceNumber
	Sequence number the exchange should expect on the next message from the user. More...
LoginMode::Enum	loginMode
	Login mode. More...
SessionSettings::Enum	sessionSettings
	Used as indicator for multiple session settings. More...
UInt8	heartbeatInterval
	Firm sets the interval. More...

Friends
class	Serializer

Detailed Description

Logon.

Constructor & Destructor Documentation

Logon

(

)

Default constructor.

Member Function Documentation

std::string toString ( ) const

virtual

Returns string representation.

Implements Message.

MessageType::Enum type ( ) const

inlinevirtual

Message type.

Implements Message.

void validate ( ) const

virtual

Validates message data by checking length limits for strings.

Throws std::invalid_artument exception if message content is invalid.

Implements Message.

Member Data Documentation

UInt8 heartbeatInterval

Firm sets the interval.

Valid range is 3 to 20 seconds. If it is invalid the default interval would be applied.

LoginMode::Enum loginMode

Login mode.

UInt32 nextExpectedSequenceNumber

Sequence number the exchange should expect on the next message from the user.

Can't be less than previously received.

std::string password

Fixed 10 byte String field.

Minimum of 8 characters with upper and lower case letters and at least one numeric character.

SessionSettings::Enum sessionSettings

Used as indicator for multiple session settings.

See the table below.

std::string userId

Fixed 8 byte String field.

Pad with null ASCII chars.