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

Class LoginConnectionConfig.ServerInfo

java.lang.Object

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

Enclosing interface:

LoginConnectionConfig

public static class LoginConnectionConfig.ServerInfo
extends java.lang.Object

Information about available servers. A list of RDMServerInfo is used by an RDMLoginRefresh to list servers available for connecting to, and whether to use them as Standby servers.

See Also:

LoginConnectionConfig.ServerInfoFlags, LoginRefresh

Constructor Summary

Constructors

Constructor and Description
ServerInfo() Instantiates a new server info.

Method Summary

Modifier and Type	Method and Description
void	applyHasLoadFactor() Applies loadFactor presence flag.
void	applyHasType() Applies serverType presence flag.
boolean	checkHasLoadFactor() Checks the presence of loadFactor field.
boolean	checkHasType() Checks the presence of serverType field.
void	clear() Clears the current contents of the server info object and prepares it for re-use.
int	copy(LoginConnectionConfig.ServerInfo destServerInfo) Performs a deep copy of LoginConnectionConfig.ServerInfo object.
int	flags() Returns the server info flags.
void	flags(int flags) Sets the server info flags.
com.thomsonreuters.upa.codec.Buffer	hostName() Returns hostName for the server.
void	hostName(com.thomsonreuters.upa.codec.Buffer hostName) Sets hostName for the server.
long	loadFactor() Returns Server's loadFactor.
void	loadFactor(long loadFactor) Sets Server's loadFactor.
long	port() Returns port for the server.
void	port(long port) Sets port for the server.
long	serverIndex() Returns an index for the server.
void	serverIndex(long serverIndex) Sets an index for the server.
int	serverType() Returns Server's serverType.
void	serverType(int serverType) Sets Server's serverType.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerInfo

public ServerInfo()

Instantiates a new server info.

Method Detail

flags

public void flags(int flags)

Sets the server info flags. Populated by LoginConnectionConfig.ServerInfoFlags.

Parameters:

flags - the flags

flags

public int flags()

Returns the server info flags. Populated by LoginConnectionConfig.ServerInfoFlags.

Returns:

flags

copy

public int copy(LoginConnectionConfig.ServerInfo destServerInfo)

Performs a deep copy of LoginConnectionConfig.ServerInfo object.

Parameters:

destServerInfo - ServerInfo object to copy this object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clear

public void clear()

Clears the current contents of the server info object and prepares it for re-use.

hostName

public com.thomsonreuters.upa.codec.Buffer hostName()

Returns hostName for the server.

Returns:

Server's hostName to connect to.

hostName

public void hostName(com.thomsonreuters.upa.codec.Buffer hostName)

Sets hostName for the server. Note that this creates garbage if buffer is backed by String object.

Parameters:

hostName - to connect to.

port

public long port()

Returns port for the server.

Returns:

Server's port to connect to.

port

public void port(long port)

Sets port for the server.

Parameters:

port - to connect to.

loadFactor

public long loadFactor()

Returns Server's loadFactor.

Returns:

Server's loadFactor.

loadFactor

public void loadFactor(long loadFactor)

Sets Server's loadFactor.

Parameters:

loadFactor - the load factor

applyHasLoadFactor

public void applyHasLoadFactor()

Applies loadFactor presence flag. This flag can also be bulk-set by flags(int)

checkHasLoadFactor

public boolean checkHasLoadFactor()

Checks the presence of loadFactor field. This flag can also be bulk-get by flags()

Returns:

true - if loadFactor is present, false - if not.

serverType

public int serverType()

Returns Server's serverType.

Returns:

Server's serverType.

serverType

public void serverType(int serverType)

Sets Server's serverType.

Parameters:

serverType - the server type

applyHasType

public void applyHasType()

Applies serverType presence flag. This flag can also be bulk-set by flags(int)

checkHasType

public boolean checkHasType()

Checks the presence of serverType field. This flag can also be bulk-get by flags()

Returns:

true - if serverType is present, false - if not.

serverIndex

public void serverIndex(long serverIndex)

Sets an index for the server.

Parameters:

serverIndex - the server index

serverIndex

public long serverIndex()

Returns an index for the server.

Returns:

an index for the server.