ObservableClient (folsom 1.7.3 API)

All Known Subinterfaces:

AsciiMemcacheClient<V>, BinaryMemcacheClient<V>, MemcacheClient<V>, RawMemcacheClient

All Known Implementing Classes:

AbstractMultiMemcacheClient, AbstractRawMemcacheClient, DefaultAsciiMemcacheClient, DefaultBinaryMemcacheClient, DefaultRawMemcacheClient, FakeRawMemcacheClient, KetamaMemcacheClient, NotConnectedClient, ReconnectingClient, ResolvingKetamaClient, RetryingClient, RoundRobinMemcacheClient
```
public interface ObservableClient
```
Implementations of this interface has a notion of connectedness to a remote and the ability to notify listeners of connection state changes.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`awaitConnected(long waitTime, java.util.concurrent.TimeUnit unit)` Wait for at least one underlying client to be connected
`default void`	`awaitDisconnected(long waitTime, java.util.concurrent.TimeUnit unit)` Wait for at least one underlying client to be disconnected
`default void`	`awaitFullyConnected(long waitTime, java.util.concurrent.TimeUnit unit)` Wait for all underlying clients to be connected
`default void`	`awaitFullyDisconnected(long waitTime, java.util.concurrent.TimeUnit unit)` Wait for all underlying clients to be disconnected
`default void`	`awaitFuture(java.util.concurrent.CompletionStage<java.lang.Void> future, long waitTime, java.util.concurrent.TimeUnit unit)`
`default java.util.concurrent.CompletionStage<java.lang.Void>`	`connectFuture()`
`default java.util.concurrent.CompletionStage<java.lang.Void>`	`disconnectFuture()`
`default java.util.concurrent.CompletionStage<java.lang.Void>`	`fullyConnectedFuture()`
`default java.util.concurrent.CompletionStage<java.lang.Void>`	`fullyDisconnectFuture()`
`java.lang.Throwable`	`getConnectionFailure()` Returns the unrecoverable connection failure, if any.
`boolean`	`isConnected()` Is the client connected to a server?
`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.
`void`	`registerForConnectionChanges(ConnectionChangeListener listener)` Register for connection change events.
`void`	`unregisterForConnectionChanges(ConnectionChangeListener listener)` Unregister the provided listener so that it no longer receives connection change callbacks.

- Method Detail
  - registerForConnectionChanges
```
void registerForConnectionChanges(ConnectionChangeListener listener)
```
    Register for connection change events. This should trigger at least once for every connection change. You should immediately get an initial callback, so that if you are creating a CompletionStage looking for a connection state that has already been reached it will return immediately.
    
    Parameters:
    
    listener - the listener to notify of connection changes
  - unregisterForConnectionChanges
```
void unregisterForConnectionChanges(ConnectionChangeListener listener)
```
    Unregister the provided listener so that it no longer receives connection change callbacks.
    
    Parameters:
    
    listener - the listener to unregister.
  - isConnected
```
boolean isConnected()
```
    Is the client connected to a server?
    
    Returns:
    
    true if the client is connected
  - connectFuture
```
default java.util.concurrent.CompletionStage<java.lang.Void> connectFuture()
```
    Returns:
    
    completes when at least one underlying client is connected
  - disconnectFuture
```
default java.util.concurrent.CompletionStage<java.lang.Void> disconnectFuture()
```
    Returns:
    
    completes when at least one underlying client is disconnected
  - fullyConnectedFuture
```
default java.util.concurrent.CompletionStage<java.lang.Void> fullyConnectedFuture()
```
    Returns:
    
    completes when all underlying clients are connected
  - fullyDisconnectFuture
```
default java.util.concurrent.CompletionStage<java.lang.Void> fullyDisconnectFuture()
```
    Returns:
    
    completes when all underlying clients are disconnected
  - awaitConnected
```
default void awaitConnected(long waitTime,
                            java.util.concurrent.TimeUnit unit)
                     throws java.util.concurrent.TimeoutException,
                            java.lang.InterruptedException
```
    Wait for at least one underlying client to be connected
    
    Throws:
    
    java.util.concurrent.TimeoutException
    
    java.lang.InterruptedException
  - awaitDisconnected
```
default void awaitDisconnected(long waitTime,
                               java.util.concurrent.TimeUnit unit)
                        throws java.util.concurrent.TimeoutException,
                               java.lang.InterruptedException
```
    Wait for at least one underlying client to be disconnected
    
    Throws:
    
    java.util.concurrent.TimeoutException
    
    java.lang.InterruptedException
  - awaitFullyConnected
```
default void awaitFullyConnected(long waitTime,
                                 java.util.concurrent.TimeUnit unit)
                          throws java.util.concurrent.TimeoutException,
                                 java.lang.InterruptedException
```
    Wait for all underlying clients to be connected
    
    Throws:
    
    java.util.concurrent.TimeoutException
    
    java.lang.InterruptedException
  - awaitFullyDisconnected
```
default void awaitFullyDisconnected(long waitTime,
                                    java.util.concurrent.TimeUnit unit)
                             throws java.util.concurrent.TimeoutException,
                                    java.lang.InterruptedException
```
    Wait for all underlying clients to be disconnected
    
    Throws:
    
    java.util.concurrent.TimeoutException
    
    java.lang.InterruptedException
  - awaitFuture
```
default void awaitFuture(java.util.concurrent.CompletionStage<java.lang.Void> future,
                         long waitTime,
                         java.util.concurrent.TimeUnit unit)
                  throws java.lang.InterruptedException,
                         java.util.concurrent.TimeoutException
```
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.TimeoutException
  - getConnectionFailure
```
java.lang.Throwable getConnectionFailure()
```
    Returns the unrecoverable connection failure, if any.
    
    Returns:
    
    null, if there's no connection failure
  - numTotalConnections
```
int numTotalConnections()
```
    How many actual socket connections do we have, including currently disconnected clients.
    
    Returns:
    
    the number of total connections
  - numActiveConnections
```
int numActiveConnections()
```
    How many active socket connections do we have (i.e. not disconnected)
    
    Returns:
    
    the number of active connections

Interface ObservableClient

Method Summary

Method Detail

registerForConnectionChanges

unregisterForConnectionChanges

isConnected

connectFuture

disconnectFuture

fullyConnectedFuture

fullyDisconnectFuture

awaitConnected

awaitDisconnected

awaitFullyConnected

awaitFullyDisconnected

awaitFuture

getConnectionFailure

numTotalConnections

numActiveConnections