io.nats.client

Interface ServerPool

public interface ServerPool

Allows the developer to provide the list of servers to try for connecting/reconnecting IMPORTANT! ServerPool IS CURRENTLY EXPERIMENTAL AND SUBJECT TO CHANGE.

Method Summary

Modifier and Type	Method and Description
boolean	acceptDiscoveredUrls(java.util.List<java.lang.String> discoveredServers) When the connection received discovered servers (ServerInfo.getConnectURLs) it passes them on to the provider for later use
void	connectFailed(NatsUri nuri) Indicate that the connection to this NatsUri failed.
void	connectSucceeded(NatsUri nuri) Indicate that the connection to this NatsUri succeeded.
java.util.List<java.lang.String>	getServerList() Get the list of servers known to the pool.
boolean	hasSecureServer() Whether the pool has any server with a secure scheme
void	initialize(Options opts) Initialize the pool.
NatsUri	nextServer() Get the next server to try to connect to.
NatsUri	peekNextServer() Just take a peek at the next server without doing any processing.
java.util.List<java.lang.String>	resolveHostToIps(java.lang.String host) Resolve a host name to an ip address

Method Detail

initialize

void initialize(Options opts)

Initialize the pool.

Parameters:

opts - the options that was used to make the connection is supplied

acceptDiscoveredUrls

boolean acceptDiscoveredUrls(java.util.List<java.lang.String> discoveredServers)

When the connection received discovered servers (ServerInfo.getConnectURLs) it passes them on to the provider for later use

Parameters:

discoveredServers - the list of discovered servers.

Returns:

true if there were any unknown servers provided

peekNextServer

NatsUri peekNextServer()

Just take a peek at the next server without doing any processing.

Returns:

the next server Nuri or null if the pool is empty.

nextServer

NatsUri nextServer()

Get the next server to try to connect to.

Returns:

the next server Nuri or null if the pool is empty.

resolveHostToIps

java.util.List<java.lang.String> resolveHostToIps(java.lang.String host)

Resolve a host name to an ip address

Parameters:

host - the host to resolve

Returns:

a list of resolved hosts. Can be empty or null.

connectSucceeded

void connectSucceeded(NatsUri nuri)

Indicate that the connection to this NatsUri succeeded.

Parameters:

nuri - should match the NatsUri given by nextServer

connectFailed

void connectFailed(NatsUri nuri)

Indicate that the connection to this NatsUri failed.

Parameters:

nuri - should match the NatsUri given by nextServer

getServerList

java.util.List<java.lang.String> getServerList()

Get the list of servers known to the pool. Purely informational

Returns:

the list of servers

hasSecureServer

boolean hasSecureServer()

Whether the pool has any server with a secure scheme

Returns:

the flag