com.spotify.folsom.client

Class DefaultRawMemcacheClient

java.lang.Object

com.spotify.folsom.AbstractRawMemcacheClient

com.spotify.folsom.client.DefaultRawMemcacheClient

All Implemented Interfaces:

ObservableClient, RawMemcacheClient

public class DefaultRawMemcacheClient
extends AbstractRawMemcacheClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DefaultRawMemcacheClient.ConnectionHandler Handles a channel connected to the address specified in the constructor.
private class	DefaultRawMemcacheClient.RequestWritePromise

Field Summary

Fields

Modifier and Type	Field and Description
private HostAndPort	address
private io.netty.channel.Channel	channel
private long	connectionTimeoutMillis
private static com.google.common.base.Supplier<io.netty.channel.EventLoopGroup>	DEFAULT_EVENT_LOOP_GROUP
private int	DEFAULT_TIMEOUT_POLL_INTERVAL_MILLIS how often to check if a request timed out, in msec.
private java.util.concurrent.atomic.AtomicReference<java.lang.String>	disconnectReason
private java.util.concurrent.Executor	executor
private BatchFlusher	flusher
private static java.util.concurrent.atomic.AtomicInteger	GLOBAL_CONNECTION_COUNT
private org.slf4j.Logger	log
private int	maxSetLength
private Metrics	metrics
private int	outstandingRequestLimit
private java.util.concurrent.atomic.AtomicInteger	pendingCounter
private int	pendingCounterLimit
private static java.util.concurrent.ThreadFactory	THREAD_FACTORY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DefaultRawMemcacheClient(HostAndPort address, io.netty.channel.Channel channel, int outstandingRequestLimit, int batchSize, java.util.concurrent.Executor executor, long connectionTimeoutMillis, Metrics metrics, int maxSetLength)

Method Summary

Modifier and Type	Method and Description
static java.util.concurrent.CompletionStage<RawMemcacheClient>	connect(HostAndPort address, int outstandingRequestLimit, int batchSize, boolean binary, java.util.concurrent.Executor executor, long connectionTimeoutMillis, java.nio.charset.Charset charset, Metrics metrics, int maxSetLength, io.netty.channel.EventLoopGroup eventLoopGroup, java.lang.Class<? extends io.netty.channel.Channel> channelClass)
private static java.lang.Class<? extends io.netty.channel.Channel>	defaultChannelClass(io.netty.channel.EventLoopGroup elg)
java.lang.Throwable	getConnectionFailure() Returns the unrecoverable connection failure, if any.
(package private) static int	getGlobalConnectionCount()
boolean	isConnected() Is the client connected to a server?
private boolean	isLostConnection(java.lang.Throwable t)
int	numActiveConnections() How many active socket connections do we have (i.e.
private int	numPendingRequests()
int	numTotalConnections() How many actual socket connections do we have, including currently disconnected clients.
private <T> java.util.concurrent.CompletionStage<T>	onExecutor(java.util.concurrent.CompletionStage<T> future)
<T> java.util.concurrent.CompletionStage<T>	send(Request<T> request)
private void	setDisconnected(java.lang.String message)
private void	setDisconnected(java.lang.Throwable cause)
void	shutdown() Shut down the client.
java.lang.String	toString()
private boolean	tryIncrementPending() Increment the pendingCounter, saving a volatile read in the fast path by doing the limit check in the CAS loop.

Methods inherited from class com.spotify.folsom.AbstractRawMemcacheClient

notifyConnectionChange, registerForConnectionChanges, unregisterForConnectionChanges

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.spotify.folsom.ObservableClient

awaitConnected, awaitDisconnected, awaitFullyConnected, awaitFullyDisconnected, awaitFuture, connectFuture, disconnectFuture, fullyConnectedFuture, fullyDisconnectFuture

Field Detail

GLOBAL_CONNECTION_COUNT

private static final java.util.concurrent.atomic.AtomicInteger GLOBAL_CONNECTION_COUNT

DEFAULT_TIMEOUT_POLL_INTERVAL_MILLIS

private final int DEFAULT_TIMEOUT_POLL_INTERVAL_MILLIS

how often to check if a request timed out, in msec.

See Also:

Constant Field Values

log

private final org.slf4j.Logger log

pendingCounter

private final java.util.concurrent.atomic.AtomicInteger pendingCounter

outstandingRequestLimit

private final int outstandingRequestLimit

channel

private final io.netty.channel.Channel channel

flusher

private final BatchFlusher flusher

address

private final HostAndPort address

executor

private final java.util.concurrent.Executor executor

connectionTimeoutMillis

private final long connectionTimeoutMillis

metrics

private final Metrics metrics

maxSetLength

private final int maxSetLength

disconnectReason

private final java.util.concurrent.atomic.AtomicReference<java.lang.String> disconnectReason

THREAD_FACTORY

private static final java.util.concurrent.ThreadFactory THREAD_FACTORY

DEFAULT_EVENT_LOOP_GROUP

private static final com.google.common.base.Supplier<io.netty.channel.EventLoopGroup> DEFAULT_EVENT_LOOP_GROUP

pendingCounterLimit

private final int pendingCounterLimit

Constructor Detail

DefaultRawMemcacheClient

private DefaultRawMemcacheClient(HostAndPort address,
                                 io.netty.channel.Channel channel,
                                 int outstandingRequestLimit,
                                 int batchSize,
                                 java.util.concurrent.Executor executor,
                                 long connectionTimeoutMillis,
                                 Metrics metrics,
                                 int maxSetLength)

Method Detail

connect

public static java.util.concurrent.CompletionStage<RawMemcacheClient> connect(HostAndPort address,
                                                                              int outstandingRequestLimit,
                                                                              int batchSize,
                                                                              boolean binary,
                                                                              java.util.concurrent.Executor executor,
                                                                              long connectionTimeoutMillis,
                                                                              java.nio.charset.Charset charset,
                                                                              Metrics metrics,
                                                                              int maxSetLength,
                                                                              io.netty.channel.EventLoopGroup eventLoopGroup,
                                                                              java.lang.Class<? extends io.netty.channel.Channel> channelClass)

defaultChannelClass

private static java.lang.Class<? extends io.netty.channel.Channel> defaultChannelClass(io.netty.channel.EventLoopGroup elg)

send

public <T> java.util.concurrent.CompletionStage<T> send(Request<T> request)

onExecutor

private <T> java.util.concurrent.CompletionStage<T> onExecutor(java.util.concurrent.CompletionStage<T> future)

tryIncrementPending

private boolean tryIncrementPending()

Increment the pendingCounter, saving a volatile read in the fast path by doing the limit check in the CAS loop.

Returns:

true if the limit was not exceeded, false otherwise.

shutdown

public void shutdown()

Description copied from interface: RawMemcacheClient

Shut down the client. Use ObservableClient.registerForConnectionChanges(ConnectionChangeListener) to to get notified when it has (possibly) finished shutting down

isConnected

public boolean isConnected()

Description copied from interface: ObservableClient

Is the client connected to a server?

Returns:

true if the client is connected

getConnectionFailure

public java.lang.Throwable getConnectionFailure()

Description copied from interface: ObservableClient

Returns the unrecoverable connection failure, if any.

Returns:

null, if there's no connection failure

numTotalConnections

public int numTotalConnections()

Description copied from interface: RawMemcacheClient

How many actual socket connections do we have, including currently disconnected clients.

Returns:

the number of total connections

numActiveConnections

public int numActiveConnections()

Description copied from interface: RawMemcacheClient

How many active socket connections do we have (i.e. not disconnected)

Returns:

the number of active connections

isLostConnection

private boolean isLostConnection(java.lang.Throwable t)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setDisconnected

private void setDisconnected(java.lang.Throwable cause)

setDisconnected

private void setDisconnected(java.lang.String message)

getGlobalConnectionCount

static int getGlobalConnectionCount()

numPendingRequests

private int numPendingRequests()