SessionConnectionSettings Class Reference

Public Member Functions
	SessionConnectionSettings (const SessionConnectionSettings &other)
virtual	~SessionConnectionSettings ()
SessionRole::Enum	role () const
unsigned	heartBeatInterval () const
bool	setResetSequenceNumbers () const
Message *	logonMessage () const
const Counterparties &	counterparties () const
SessionConnectionSettings &	operator= (const SessionConnectionSettings &other)

Protected Member Functions
	SessionConnectionSettings (SessionRole::Enum role)
void	heartBeatInterval (unsigned interval)
void	setResetSequenceNumbers (bool resetSeqNumbers)
void	logonMessage (const Message &message)
Counterparties &	counterparties ()

Detailed Description

Definition at line 73 of file SessionConnectionSettings.h.

Constructor & Destructor Documentation

SessionConnectionSettings() [1/2]

SessionConnectionSettings

(

const SessionConnectionSettings &

other

)

Initializes an instance from another one.

~SessionConnectionSettings()

virtual ~SessionConnectionSettings ( )

virtual

Cleans an instance up.

SessionConnectionSettings() [2/2]

SessionConnectionSettings ( SessionRole::Enum role )

protected

Initializes an instance with the given session role.

Member Function Documentation

counterparties() [1/2]

Counterparties & counterparties ( )

protected

The editable collection of counterparties.

counterparties() [2/2]

const Counterparties & counterparties ( ) const

inline

The list of all counterparties.

It is not used if the session must be logged on as an acceptor.

Definition at line 168 of file SessionConnectionSettings.h.

heartBeatInterval() [1/2]

unsigned heartBeatInterval ( ) const

inline

If the session must be logged on in the role of an initiator, defines the value for the heartbeat interval in seconds.

Otherwise it has an undefined value.

Definition at line 147 of file SessionConnectionSettings.h.

heartBeatInterval() [2/2]

void heartBeatInterval ( unsigned interval )

protected

Updates the heartbeat interval value.

logonMessage() [1/2]

Message * logonMessage ( ) const

inline

If the session must be logged on in the role of an initiator, defines the custom logon message which must be sent at the logon.

Otherwise it returns the NULL value.

Definition at line 161 of file SessionConnectionSettings.h.

logonMessage() [2/2]

void logonMessage ( const Message & message )

protected

Assigns the custom logon message.

operator=()

SessionConnectionSettings & operator=

(

const SessionConnectionSettings &

other

)

Copies all settings from another instance.

role()

SessionRole::Enum role ( ) const

inline

Specifies whether the session must be connected as an acceptor or initiator.

Definition at line 140 of file SessionConnectionSettings.h.

setResetSequenceNumbers() [1/2]

bool setResetSequenceNumbers ( ) const

inline

If the session must be logged on in the role of an initiator, defines whether the 'SetResetSequenceNumbers' flag must be sent within the logon message.

Otherwise it has an undefined value.

Definition at line 154 of file SessionConnectionSettings.h.

setResetSequenceNumbers() [2/2]

void setResetSequenceNumbers ( bool resetSeqNumbers )

protected

Updates the session reset sequence numbers policy.