com.netflix.client

Class PrimeConnections

java.lang.Object

com.netflix.client.PrimeConnections

public class PrimeConnections
extends java.lang.Object

Prime the connections for a given Client (For those Client that have a LoadBalancer that knows the set of Servers it will connect to) This is mainly done to address those deployment environments (Read EC2) which benefit from a firewall connection/path warmup prior to actual use for live requests.

This class is not protocol specific. Actual priming operation is delegated to instance of IPrimeConnection, which is instantiated using reflection according to property CommonClientConfigKey.PrimeConnectionsClassName.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrimeConnections.PrimeConnectionEndStats
static interface	PrimeConnections.PrimeConnectionListener

Constructor Summary

Constructors

Constructor and Description
PrimeConnections(java.lang.String name, com.netflix.client.config.IClientConfig niwsClientConfig)
PrimeConnections(java.lang.String name, int maxRetries, long maxTotalTimeToPrimeConnections, java.lang.String primeConnectionsURI)
PrimeConnections(java.lang.String name, int maxRetries, long maxTotalTimeToPrimeConnections, java.lang.String primeConnectionsURI, float primeRatio)

Method Summary

Modifier and Type	Method and Description
PrimeConnections.PrimeConnectionEndStats	getEndStats()
void	primeConnections(java.util.List<Server> servers) Prime connections, blocking until configured percentage (default is 100%) of target servers are primed or max time is reached.
java.util.List<java.util.concurrent.Future<java.lang.Boolean>>	primeConnectionsAsync(java.util.List<Server> servers, PrimeConnections.PrimeConnectionListener listener) Prime servers asynchronously.
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimeConnections

public PrimeConnections(java.lang.String name,
                        com.netflix.client.config.IClientConfig niwsClientConfig)

PrimeConnections

public PrimeConnections(java.lang.String name,
                        int maxRetries,
                        long maxTotalTimeToPrimeConnections,
                        java.lang.String primeConnectionsURI)

PrimeConnections

public PrimeConnections(java.lang.String name,
                        int maxRetries,
                        long maxTotalTimeToPrimeConnections,
                        java.lang.String primeConnectionsURI,
                        float primeRatio)

Method Detail

primeConnections

public void primeConnections(java.util.List<Server> servers)

Prime connections, blocking until configured percentage (default is 100%) of target servers are primed or max time is reached.

See Also:

CommonClientConfigKey.MinPrimeConnectionsRatio, CommonClientConfigKey.MaxTotalTimeToPrimeConnections

getEndStats

public PrimeConnections.PrimeConnectionEndStats getEndStats()

primeConnectionsAsync

public java.util.List<java.util.concurrent.Future<java.lang.Boolean>> primeConnectionsAsync(java.util.List<Server> servers,
                                                                                            PrimeConnections.PrimeConnectionListener listener)

Prime servers asynchronously.

Parameters:

servers -

listener -

shutdown

public void shutdown()