MemcacheClientBuilder (folsom 0.8.0 API)

java.lang.Object
- com.spotify.folsom.MemcacheClientBuilder<V>

public class MemcacheClientBuilder<V>
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`MemcacheClientBuilder.DefaultDnsResolver` Lazily instantiated singleton default srvResolver.
`private static class`	`MemcacheClientBuilder.DefaultExecutor` Lazily instantiated singleton default executor.
`private static class`	`MemcacheClientBuilder.DefaultScheduledExecutor` Lazily instantiated singleton default scheduled executor.

Field Summary

Fields
Modifier and Type	Field and Description
`private List<com.google.common.net.HostAndPort>`	`addresses`
`private BackoffFunction`	`backoffFunction`
`private Charset`	`charset`
`private int`	`connections`
`private static String`	`DEFAULT_HOSTNAME`
`private static int`	`DEFAULT_MAX_OUTSTANDING`
`private static int`	`DEFAULT_MAX_SET_LENGTH`
`private static int`	`DEFAULT_PORT`
`private long`	`dnsRefreshPeriod`
`private Executor`	`executor`
`private int`	`maxOutstandingRequests`
`private int`	`maxSetLength`
`private Metrics`	`metrics`
`private boolean`	`retry`
`private long`	`shutdownDelay`
`private String`	`srvRecord`
`private com.spotify.dns.DnsSrvResolver`	`srvResolver`
`private long`	`timeoutMillis`
`private Transcoder<V>`	`valueTranscoder`

Constructor Summary

Constructors
Constructor and Description

MemcacheClientBuilder(Transcoder<V> valueTranscoder)
Create a client builder with the provided value transcoder.

Constructors
Constructor and Description
`MemcacheClientBuilder(Transcoder<V> valueTranscoder)` Create a client builder with the provided value transcoder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AsciiMemcacheClient<V>`	`connectAscii()` Create a client that uses the ascii memcache protocol.
`BinaryMemcacheClient<V>`	`connectBinary()` Create a client that uses the binary memcache protocol.
`protected RawMemcacheClient`	`connectRaw(boolean binary)` Connect a raw memcached client without any protocol specific methods.
`private RawMemcacheClient`	`createClient(com.google.common.net.HostAndPort address, boolean binary)`
`private List<RawMemcacheClient>`	`createClients(List<com.google.common.net.HostAndPort> addresses, boolean binary)`
`private RawMemcacheClient`	`createReconnectingClient(com.google.common.net.HostAndPort address, boolean binary)`
`private RawMemcacheClient`	`createSRVClient(boolean binary)`
`static MemcacheClientBuilder<byte[]>`	`newByteArrayClient()` Create a client builder for byte array values.
`static MemcacheClientBuilder<Serializable>`	`newSerializableObjectClient()` Create a client builder for serializable object values.
`static MemcacheClientBuilder<String>`	`newStringClient()` Create a client builder with a basic string transcoder using the UTF-8 Charset.
`static MemcacheClientBuilder<String>`	`newStringClient(Charset charset)` Create a client builder with a basic string transcoder using the supplied Charset.
`MemcacheClientBuilder<V>`	`withAddress(com.google.common.net.HostAndPort address)` Define which memcache server to connect to.
`MemcacheClientBuilder<V>`	`withAddress(String hostname)` Define which memcache server to connect to.
`MemcacheClientBuilder<V>`	`withAddresses(List<com.google.common.net.HostAndPort> addresses)` Define which memcache servers to connect to.
`MemcacheClientBuilder<V>`	`withBackoff(BackoffFunction backoffFunction)` Specify how long the client should wait between reconnects.
`MemcacheClientBuilder<V>`	`withConnections(int connections)` Use multiple connections to each memcache server.
`MemcacheClientBuilder<V>`	`withKeyCharset(Charset charset)` Define the charset encoding for keys.
`MemcacheClientBuilder<V>`	`withMaxOutstandingRequests(int maxOutstandingRequests)` Specify the maximum number of requests in the queue per server connection.
`MemcacheClientBuilder<V>`	`withMaxSetLength(int maxSetLength)` Set the maximum value size for set requests.
`MemcacheClientBuilder<V>`	`withMetrics(Metrics metrics)` Specify how to collect metrics.
`MemcacheClientBuilder<V>`	`withReplyExecutor(Executor executor)` Specify an executor to execute all replies on.
`MemcacheClientBuilder<V>`	`withRequestTimeoutMillis(long timeoutMillis)` Enforce a timeout for requests to complete, closing the connection and reconnecting if the timeout is exceeded.
`MemcacheClientBuilder<V>`	`withRetry(boolean retry)` Specify if the client should retry once if the connection is closed.
`MemcacheClientBuilder<V>`	`withSRVRecord(String srvRecord)` Use SRV to lookup nodes instead of a fixed set of addresses.
`MemcacheClientBuilder<V>`	`withSRVRefreshPeriod(long periodMillis)` This is only used for the SRV based ketama client.
`MemcacheClientBuilder<V>`	`withSrvResolver(com.spotify.dns.DnsSrvResolver srvResolver)` Use a specific SRV resolver.
`MemcacheClientBuilder<V>`	`withSRVShutdownDelay(long shutdownDelay)` This is only used for the SRV based ketama client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_SET_LENGTH
```
private static final int DEFAULT_MAX_SET_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_OUTSTANDING
```
private static final int DEFAULT_MAX_OUTSTANDING
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOSTNAME
```
private static final String DEFAULT_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
private static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - addresses
```
private List<com.google.common.net.HostAndPort> addresses
```
  - maxOutstandingRequests
```
private int maxOutstandingRequests
```
  - valueTranscoder
```
private final Transcoder<V> valueTranscoder
```
  - metrics
```
private Metrics metrics
```
  - backoffFunction
```
private BackoffFunction backoffFunction
```
  - connections
```
private int connections
```
  - retry
```
private boolean retry
```
  - executor
```
private Executor executor
```
  - charset
```
private Charset charset
```
  - srvResolver
```
private com.spotify.dns.DnsSrvResolver srvResolver
```
  - srvRecord
```
private String srvRecord
```
  - dnsRefreshPeriod
```
private long dnsRefreshPeriod
```
  - shutdownDelay
```
private long shutdownDelay
```
  - timeoutMillis
```
private long timeoutMillis
```
  - maxSetLength
```
private int maxSetLength
```
- Constructor Detail
  - MemcacheClientBuilder
```
public MemcacheClientBuilder(Transcoder<V> valueTranscoder)
```
    Create a client builder with the provided value transcoder.
    
    Parameters:
    
    valueTranscoder - the transcoder to use to encode/decode values.
- Method Detail
  - newByteArrayClient
```
public static MemcacheClientBuilder<byte[]> newByteArrayClient()
```
    Create a client builder for byte array values.
    
    Returns:
    
    The builder
  - newStringClient
```
public static MemcacheClientBuilder<String> newStringClient()
```
    Create a client builder with a basic string transcoder using the UTF-8 Charset.
    
    Returns:
    
    The builder
  - newStringClient
```
public static MemcacheClientBuilder<String> newStringClient(Charset charset)
```
    Create a client builder with a basic string transcoder using the supplied Charset.
    
    Parameters:
    
    charset - the Charset to encode and decode String objects with.
    
    Returns:
    
    The builder
  - newSerializableObjectClient
```
public static MemcacheClientBuilder<Serializable> newSerializableObjectClient()
```
    Create a client builder for serializable object values.
    
    Returns:
    
    The builder
  - withKeyCharset
```
public MemcacheClientBuilder<V> withKeyCharset(Charset charset)
```
    Define the charset encoding for keys. Note that some charsets may not be compatible with the memcache protocol which requires that keys are a string of 8-bit characters with the exclusion of characters in the range [0x00, 0x20]. This is a problem in charsets such as UTF-16 which uses two bytes and one of them could easily be invalid for memcache purposes. UTF-8 and most single-byte charsets should be fine though.
    
    Parameters:
    
    charset - The charset encoding for keys. The default is UTF-8.
    
    Returns:
    
    itself
  - withAddress
```
public MemcacheClientBuilder<V> withAddress(String hostname)
```
    Define which memcache server to connect to.
    
    Parameters:
    
    hostname - a server, using the default memcached port (11211).
    
    Returns:
    
    itself
  - withAddress
```
public MemcacheClientBuilder<V> withAddress(com.google.common.net.HostAndPort address)
```
    Define which memcache server to connect to.
    
    Parameters:
    
    address - a server.
    
    Returns:
    
    itself
  - withAddresses
```
public MemcacheClientBuilder<V> withAddresses(List<com.google.common.net.HostAndPort> addresses)
```
    Define which memcache servers to connect to. If more than one address is given, Ketama will be used to distribute requests.
    
    Parameters:
    
    addresses - a list of servers.
    
    Returns:
    
    itself
  - withSRVRecord
```
public MemcacheClientBuilder<V> withSRVRecord(String srvRecord)
```
    Use SRV to lookup nodes instead of a fixed set of addresses. This means that the set of nodes can change dynamically over time.
    
    Parameters:
    
    srvRecord - the SRV record to use.
    
    Returns:
    
    itself
  - withSRVRefreshPeriod
```
public MemcacheClientBuilder<V> withSRVRefreshPeriod(long periodMillis)
```
    This is only used for the SRV based ketama client. This is the maximum time DNS should be queried for updates. It can be shorter, depending the ttl values in the DNS lookup result
    
    Parameters:
    
    periodMillis - time in milliseonds. The default is 60 seconds.
    
    Returns:
    
    itself
  - withSRVShutdownDelay
```
public MemcacheClientBuilder<V> withSRVShutdownDelay(long shutdownDelay)
```
    This is only used for the SRV based ketama client. When the SRV record has changed, the old client will be shutdown after this much time has passed, in order to complete pending requests.
    
    Parameters:
    
    shutdownDelay - time in milliseconds. The default is 60 seconds.
    
    Returns:
    
    itself
  - withSrvResolver
```
public MemcacheClientBuilder<V> withSrvResolver(com.spotify.dns.DnsSrvResolver srvResolver)
```
    Use a specific SRV resolver.
    
    Parameters:
    
    srvResolver - the resolver to use. Default is a caching resolver from DnsSrvResolvers
    
    Returns:
    
    itself
  - withMetrics
```
public MemcacheClientBuilder<V> withMetrics(Metrics metrics)
```
    Specify how to collect metrics.
    
    Parameters:
    
    metrics - Default is NoopMetrics - which doesn't collect anything.
    
    Returns:
    
    itself
  - withMaxOutstandingRequests
```
public MemcacheClientBuilder<V> withMaxOutstandingRequests(int maxOutstandingRequests)
```
    Specify the maximum number of requests in the queue per server connection. If this is set too low, requests will fail with MemcacheOverloadedException. If this is set too high, there is a risk of having high latency requests and delaying the time to notice that the system is malfunctioning.
    
    Parameters:
    
    maxOutstandingRequests - the maximum number of requests that can be in queue. Default is 1000.
    
    Returns:
    
    itself
  - withBackoff
```
public MemcacheClientBuilder<V> withBackoff(BackoffFunction backoffFunction)
```
    Specify how long the client should wait between reconnects.
    
    Parameters:
    
    backoffFunction - A custom backoff function. Default is exponential backoff.
    
    Returns:
    
    itself.
  - withRetry
```
public MemcacheClientBuilder<V> withRetry(boolean retry)
```
    Specify if the client should retry once if the connection is closed. This typically only has an effect when one of the ketama nodes disconnect while the request is sent.
    
    Parameters:
    
    retry - Default is true
    
    Returns:
    
    itself
  - withReplyExecutor
```
public MemcacheClientBuilder<V> withReplyExecutor(Executor executor)
```
    Specify an executor to execute all replies on. Default is a shared ForkJoinPool in async mode with one thread per processor.
    
    Parameters:
    
    executor - the executor to use.
    
    Returns:
    
    itself
  - withConnections
```
public MemcacheClientBuilder<V> withConnections(int connections)
```
    Use multiple connections to each memcache server. This is likely not a useful thing in practice, unless the IO connection really becomes a bottleneck.
    
    Parameters:
    
    connections - Number of connections, must be 1 or greater. The default is 1
    
    Returns:
    
    itself
  - withRequestTimeoutMillis
```
public MemcacheClientBuilder<V> withRequestTimeoutMillis(long timeoutMillis)
```
    Enforce a timeout for requests to complete, closing the connection and reconnecting if the timeout is exceeded.
    
    Parameters:
    
    timeoutMillis - The timeout in milliseconds. The default is 3000 ms.
    
    Returns:
    
    itself
  - withMaxSetLength
```
public MemcacheClientBuilder<V> withMaxSetLength(int maxSetLength)
```
    Set the maximum value size for set requests. If the limit is exceeded the set operation will fast-fail with a VALUE_TOO_LARGE status. If this limit is set higher than the actual limit in the memcache service, the memcache service may return a SERVER_ERROR which will close the connection to prevent any corrupted state. The default value is 1 MiB
    
    Parameters:
    
    maxSetLength - The maximum size in bytes
    
    Returns:
    
    itself
  - connectBinary
```
public BinaryMemcacheClient<V> connectBinary()
```
    Create a client that uses the binary memcache protocol.
    
    Returns:
    
    a BinaryMemcacheClient
  - connectAscii
```
public AsciiMemcacheClient<V> connectAscii()
```
    Create a client that uses the ascii memcache protocol.
    
    Returns:
    
    a AsciiMemcacheClient
  - connectRaw
```
protected RawMemcacheClient connectRaw(boolean binary)
```
    Connect a raw memcached client without any protocol specific methods. This should rarely be needed.
    
    Parameters:
    
    binary - whether to use the binary protocol or not.
    
    Returns:
    
    A raw memcached client.
  - createClients
```
private List<RawMemcacheClient> createClients(List<com.google.common.net.HostAndPort> addresses,
                                              boolean binary)
```
  - createSRVClient
```
private RawMemcacheClient createSRVClient(boolean binary)
```
  - createClient
```
private RawMemcacheClient createClient(com.google.common.net.HostAndPort address,
                                       boolean binary)
```
  - createReconnectingClient
```
private RawMemcacheClient createReconnectingClient(com.google.common.net.HostAndPort address,
                                                   boolean binary)
```

Class MemcacheClientBuilder<V>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_SET_LENGTH

DEFAULT_MAX_OUTSTANDING

DEFAULT_HOSTNAME

DEFAULT_PORT

addresses

maxOutstandingRequests

valueTranscoder

metrics

backoffFunction

connections

retry

executor

charset

srvResolver

srvRecord

dnsRefreshPeriod

shutdownDelay

timeoutMillis

maxSetLength

Constructor Detail

MemcacheClientBuilder

Method Detail

newByteArrayClient

newStringClient

newStringClient

newSerializableObjectClient

withKeyCharset

withAddress

withAddress

withAddresses

withSRVRecord

withSRVRefreshPeriod

withSRVShutdownDelay

withSrvResolver

withMetrics

withMaxOutstandingRequests

withBackoff

withRetry

withReplyExecutor

withConnections

withRequestTimeoutMillis

withMaxSetLength

connectBinary

connectAscii

connectRaw

createClients

createSRVClient

createClient

createReconnectingClient