com.thomsonreuters.upa.valueadd.domainrep.rdm.login

Interface LoginConsumerConnectionStatus

All Superinterfaces:

LoginMsg, MsgBase

public interface LoginConsumerConnectionStatus
extends LoginMsg

The RDM Login Consumer Connection Status. Used by an OMM Consumer to send Warm Standby information.

See Also:

MsgBase, LoginWarmStandbyInfo

Method Summary

Modifier and Type	Method and Description
void	applyHasWarmStandbyInfo() Checks the presence of Warm Standby Information.
boolean	checkHasWarmStandbyInfo() Checks the presence of Warm Standby Information.
int	copy(LoginConsumerConnectionStatus destConnStatusMsg) Performs a deep copy of LoginConsumerConnectionStatus object.
int	flags() The Consumer Connection Status flags.
void	flags(int flags) The Consumer Connection Status flags.
LoginWarmStandbyInfo	warmStandbyInfo() Warm Standby Information.
void	warmStandbyInfo(LoginWarmStandbyInfo warmStandbyInfo) Warm Standby Information.

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.login.LoginMsg

rdmMsgType, rdmMsgType

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.MsgBase

clear, decode, domainType, encode, streamId, streamId

Method Detail

flags

int flags()

The Consumer Connection Status flags. Populated by LoginConsumerConnectionStatusFlags.

Returns:

flags

flags

void flags(int flags)

The Consumer Connection Status flags. Populated by LoginConsumerConnectionStatusFlags.

Parameters:

flags - the flags

checkHasWarmStandbyInfo

boolean checkHasWarmStandbyInfo()

Checks the presence of Warm Standby Information. Flags may also be bulk-get via flags().

Returns:

true if warm standby info is present. If not, returns false.

applyHasWarmStandbyInfo

void applyHasWarmStandbyInfo()

Checks the presence of Warm Standby Information. Flags may also be bulk-set via flags().

warmStandbyInfo

LoginWarmStandbyInfo warmStandbyInfo()

Warm Standby Information. Presence indicated by LoginConsumerConnectionStatusFlags.HAS_WARM_STANDBY_INFO.

Returns:

Warm standby information. While encoding, returned object may be populated with the value to be encoded.

warmStandbyInfo

void warmStandbyInfo(LoginWarmStandbyInfo warmStandbyInfo)

Warm Standby Information. Presence indicated by LoginConsumerConnectionStatusFlags.HAS_WARM_STANDBY_INFO.

Parameters:

warmStandbyInfo - -Warm standby information.

copy

int copy(LoginConsumerConnectionStatus destConnStatusMsg)

Performs a deep copy of LoginConsumerConnectionStatus object.

Parameters:

destConnStatusMsg - Message to copy login consumer connection status object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.