com.couchbase.client.core.endpoint

Class AbstractEndpoint

java.lang.Object

com.couchbase.client.core.state.AbstractStateMachine<LifecycleState>

com.couchbase.client.core.endpoint.AbstractEndpoint

All Implemented Interfaces:

Endpoint, Stateful<LifecycleState>

Direct Known Subclasses:

ConfigEndpoint, KeyValueEndpoint, QueryEndpoint, ViewEndpoint

public abstract class AbstractEndpoint
extends AbstractStateMachine<LifecycleState>
implements Endpoint

The common parent implementation for all Endpoints.

This parent implementation provides common functionality that all Endpoints need, most notably bootstrapping, connecting and reconnecting.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RECONNECT_DELAY The maximum reconnect delay in milliseconds, so it does not grow out of bounds.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEndpoint(java.lang.String bucket, java.lang.String password, BootstrapAdapter adapter) Constructor to which allows to pass in an artificial bootstrap adapter.
protected	AbstractEndpoint(java.lang.String hostname, java.lang.String bucket, java.lang.String password, int port, CoreEnvironment environment, com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer) Create a new AbstractEndpoint.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	bucket() The name of the bucket.
rx.Observable<LifecycleState>	connect() Connect the Endpoint to the underlying channel.
protected abstract void	customEndpointHandlers(io.netty.channel.ChannelPipeline pipeline) Add custom endpoint handlers to the ChannelPipeline.
rx.Observable<LifecycleState>	disconnect() Disconnect the Endpoint from the underlying channel.
protected void	doConnect(rx.subjects.Subject<LifecycleState,LifecycleState> observable) Helper method to perform the actual connect and reconnect.
CoreEnvironment	environment() The CoreEnvironment reference.
protected static java.lang.String	logIdent(io.netty.channel.Channel chan, Endpoint endpoint) Simple log helper to give logs a common prefix.
void	notifyChannelInactive() Helper method that is called from inside the event loop to notify the upper Endpoint of a disconnect.
protected java.lang.String	password() The password of the bucket.
com.lmax.disruptor.RingBuffer<ResponseEvent>	responseBuffer() The RingBuffer response buffer reference.
void	send(CouchbaseRequest request) Sends a CouchbaseRequest into the endpoint and eventually returns a CouchbaseResponse.

Methods inherited from class com.couchbase.client.core.state.AbstractStateMachine

isState, state, states, transitionState

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.couchbase.client.core.state.Stateful

isState, state, states

Field Detail

MAX_RECONNECT_DELAY

public static final int MAX_RECONNECT_DELAY

The maximum reconnect delay in milliseconds, so it does not grow out of bounds.

See Also:

Constant Field Values

Constructor Detail

AbstractEndpoint

protected AbstractEndpoint(java.lang.String bucket,
                java.lang.String password,
                BootstrapAdapter adapter)

Constructor to which allows to pass in an artificial bootstrap adapter.

This method should not be used outside of tests. Please use the AbstractEndpoint(String, String, String, int, CoreEnvironment, RingBuffer) constructor instead.

Parameters:

bucket - the name of the bucket.

password - the password of the bucket.

adapter - the bootstrap adapter.

AbstractEndpoint

protected AbstractEndpoint(java.lang.String hostname,
                java.lang.String bucket,
                java.lang.String password,
                int port,
                CoreEnvironment environment,
                com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer)

Create a new AbstractEndpoint.

Parameters:

hostname - the hostname/ipaddr of the remote channel.

bucket - the name of the bucket.

password - the password of the bucket.

port - the port of the remote channel.

environment - the environment of the core.

responseBuffer - the response buffer for passing responses up the stack.

Method Detail

customEndpointHandlers

protected abstract void customEndpointHandlers(io.netty.channel.ChannelPipeline pipeline)

Add custom endpoint handlers to the ChannelPipeline.

This method needs to be implemented by the actual endpoint implementations to add specific handlers to the pipeline depending on the endpoint type and intended behavior.

Parameters:

pipeline - the pipeline where to add handlers.

connect

public rx.Observable<LifecycleState> connect()

Description copied from interface: Endpoint

Connect the Endpoint to the underlying channel.

Specified by:

connect in interface Endpoint

Returns:

a Observable with the state after the connect process finishes.

doConnect

protected void doConnect(rx.subjects.Subject<LifecycleState,LifecycleState> observable)

Helper method to perform the actual connect and reconnect.

Parameters:

observable - the Subject which is eventually notified if the connect process succeeded or failed.

disconnect

public rx.Observable<LifecycleState> disconnect()

Description copied from interface: Endpoint

Disconnect the Endpoint from the underlying channel.

Specified by:

disconnect in interface Endpoint

Returns:

a Observable with the state after the disconnect process finishes.

send

public void send(CouchbaseRequest request)

Description copied from interface: Endpoint

Sends a CouchbaseRequest into the endpoint and eventually returns a CouchbaseResponse.

Specified by:

send in interface Endpoint

Parameters:

request - the request to send.

notifyChannelInactive

public void notifyChannelInactive()

Helper method that is called from inside the event loop to notify the upper Endpoint of a disconnect.

Note that the connect method is only called if the endpoint is currently connected, since otherwise this would try to connect to a socket which has already been removed on a failover/rebalance out.

Subsequent reconnect attempts are triggered from here.

bucket

protected java.lang.String bucket()

The name of the bucket.

Returns:

the bucket name.

password

protected java.lang.String password()

The password of the bucket.

Returns:

the bucket password.

environment

public CoreEnvironment environment()

The CoreEnvironment reference.

Returns:

the environment.

responseBuffer

public com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer()

The RingBuffer response buffer reference.

Returns:

the response buffer.

logIdent

protected static java.lang.String logIdent(io.netty.channel.Channel chan,
                        Endpoint endpoint)

Simple log helper to give logs a common prefix.

Parameters:

chan - the address.

endpoint - the endpoint.

Returns:

a prefix string for logs.