io.nats.client

Interface ServerPool

public interface ServerPool

Allows the developer to provide the list of servers to try for connecting/reconnecting

Method Summary

Modifier and Type	Method and Description
boolean	acceptDiscoveredUrls(@NonNull 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(@NonNull io.nats.client.support.NatsUri nuri) Indicate that the connection to this NatsUri failed.
void	connectSucceeded(@NonNull io.nats.client.support.NatsUri nuri) Indicate that the connection to this NatsUri succeeded.
@NonNull 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(@NonNull Options opts) Initialize the pool.
@Nullable io.nats.client.support.NatsUri	nextServer() Get the next server to try to connect to.
@Nullable io.nats.client.support.NatsUri	peekNextServer() Just take a peek at the next server without doing any processing.
@Nullable java.util.List<java.lang.String>	resolveHostToIps(@NonNull java.lang.String host) Resolve a host name to an ip address

Method Detail

initialize

void initialize(@NonNull Options opts)

Initialize the pool.

Parameters:

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

acceptDiscoveredUrls

boolean acceptDiscoveredUrls(@NonNull 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

@Nullable io.nats.client.support.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

@Nullable io.nats.client.support.NatsUri nextServer()

Get the next server to try to connect to.

Returns:

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

resolveHostToIps

@Nullable java.util.List<java.lang.String> resolveHostToIps(@NonNull 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 null.

connectSucceeded

void connectSucceeded(@NonNull io.nats.client.support.NatsUri nuri)

Indicate that the connection to this NatsUri succeeded.

Parameters:

nuri - should match the NatsUri given by nextServer

connectFailed

void connectFailed(@NonNull io.nats.client.support.NatsUri nuri)

Indicate that the connection to this NatsUri failed.

Parameters:

nuri - should match the NatsUri given by nextServer

getServerList

@NonNull 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