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 com.google.common.net.HostAndPort	address
private io.netty.channel.Channel	channel
private static io.netty.util.concurrent.DefaultThreadFactory	DAEMON_THREAD_FACTORY
private AtomicReference<String>	disconnectReason
private static io.netty.channel.EventLoopGroup	EVENT_LOOP_GROUP
private Executor	executor
private BatchFlusher	flusher
private org.slf4j.Logger	log
private int	maxSetLength
private int	outstandingRequestLimit
private AtomicInteger	pendingCounter
private int	requestSequenceId Used to set the opaque field for binary requests, to be able to detect messages out of order.
private long	timeoutMillis

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DefaultRawMemcacheClient(com.google.common.net.HostAndPort address, io.netty.channel.Channel channel, int outstandingRequestLimit, Executor executor, long timeoutMillis, Metrics metrics, int maxSetLength)

Method Summary

Modifier and Type	Method and Description
static com.google.common.util.concurrent.ListenableFuture<RawMemcacheClient>	connect(com.google.common.net.HostAndPort address, int outstandingRequestLimit, boolean binary, Executor executor, long timeoutMillis, Charset charset, Metrics metrics, int maxSetLength)
boolean	isConnected() Is the client connected to a server?
private boolean	isLostConnection(Throwable t)
int	numActiveConnections() How many active socket connections do we have (i.e.
int	numTotalConnections() How many actual socket connections do we have, including currently disconnected clients.
private <T> com.google.common.util.concurrent.ListenableFuture<T>	onExecutor(com.google.common.util.concurrent.ListenableFuture<T> future)
private static <T> com.google.common.util.concurrent.ListenableFuture<T>	onExecutor(com.google.common.util.concurrent.ListenableFuture<T> future, Executor executor)
<T> com.google.common.util.concurrent.ListenableFuture<T>	send(Request<T> request)
private void	setDisconnected(String message)
private void	setDisconnected(Throwable cause)
void	shutdown() Shut down the client.
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

Field Detail

DAEMON_THREAD_FACTORY

private static final io.netty.util.concurrent.DefaultThreadFactory DAEMON_THREAD_FACTORY

EVENT_LOOP_GROUP

private static final io.netty.channel.EventLoopGroup EVENT_LOOP_GROUP

log

private final org.slf4j.Logger log

pendingCounter

private final AtomicInteger pendingCounter

outstandingRequestLimit

private final int outstandingRequestLimit

channel

private final io.netty.channel.Channel channel

flusher

private final BatchFlusher flusher

address

private final com.google.common.net.HostAndPort address

executor

private final Executor executor

timeoutMillis

private final long timeoutMillis

maxSetLength

private final int maxSetLength

disconnectReason

private final AtomicReference<String> disconnectReason

requestSequenceId

private int requestSequenceId

Used to set the opaque field for binary requests, to be able to detect messages out of order. A regular int is used, because this is only accessed from the single writer thread

Constructor Detail

DefaultRawMemcacheClient

private DefaultRawMemcacheClient(com.google.common.net.HostAndPort address,
                                 io.netty.channel.Channel channel,
                                 int outstandingRequestLimit,
                                 Executor executor,
                                 long timeoutMillis,
                                 Metrics metrics,
                                 int maxSetLength)

Method Detail

connect

public static com.google.common.util.concurrent.ListenableFuture<RawMemcacheClient> connect(com.google.common.net.HostAndPort address,
                                                                                            int outstandingRequestLimit,
                                                                                            boolean binary,
                                                                                            Executor executor,
                                                                                            long timeoutMillis,
                                                                                            Charset charset,
                                                                                            Metrics metrics,
                                                                                            int maxSetLength)

send

public <T> com.google.common.util.concurrent.ListenableFuture<T> send(Request<T> request)

onExecutor

private <T> com.google.common.util.concurrent.ListenableFuture<T> onExecutor(com.google.common.util.concurrent.ListenableFuture<T> future)

onExecutor

private static <T> com.google.common.util.concurrent.ListenableFuture<T> onExecutor(com.google.common.util.concurrent.ListenableFuture<T> future,
                                                                                    Executor executor)

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

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(Throwable t)

toString

public String toString()

Overrides:

toString in class Object

setDisconnected

private void setDisconnected(Throwable cause)

setDisconnected

private void setDisconnected(String message)