com.netflix.dyno.connectionpool.Connection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dyno-core Show documentation
dyno-core
There is a newer version: 1.9.1
/*******************************************************************************
 * Copyright 2011 Netflix
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package com.netflix.dyno.connectionpool;

import com.netflix.dyno.connectionpool.exception.DynoConnectException;
import com.netflix.dyno.connectionpool.exception.DynoException;

/**
 * Interface to an instance of a connection on a host.
 *
 * @param 
 * @author poberai
 */
public interface Connection {

    /**
     * Execute an operation on the connection and return a result
     *
     * @param 
     * @param op
     * @throws DynoException
     */
    public  OperationResult execute(Operation op) throws DynoException;

    public  ListenableFuture> executeAsync(AsyncOperation op) throws DynoException;

    /**
     * Shut down the connection. isOpen() will now return false.
     */
    public void close();

    /**
     * @return Get the host for this connection
     */
    public Host getHost();

    /**
     * Open a new connection
     *
     * @throws DynoException
     */
    public void open() throws DynoException;

    /**
     * Can be used by clients to indicate connection exception.
     * This can be analyzed by connection pools later
     * e.g remove host from connection pool etc.
     *
     * @return
     */
    public DynoConnectException getLastException();

    /**
     * Return the parent HostConnectionPool that manages this connection.
     * This is generally useful for meta operations on HostConnectionPool(s) when dealing with their Connection(s)
     * e.g
     * 1. Return connections safely to the parent pool after executing operations on them
     * 2. Reporting error stats to parent pools when performing ops on connections. The parent pools can then
     * decide whether the connections should be recycled etc.
     *
     * @return
     */
    public HostConnectionPool getParentConnectionPool();

    /**
     * Operation to send ping heartbeats on Connection(s)
     * This is primarily used for active monitoring so that stale/bad connections to Hosts can be recycled.
     */
    public void execPing();

    /**
     * Can be used by different layers within dyno to add valuable information to the Connection.
     *
     * @return ConnectionContext
     */
    public ConnectionContext getContext();
}