org.littleshoot.proxy.HttpProxyServer Maven / Gradle / Ivy

Go to download
package org.littleshoot.proxy;

import java.net.InetSocketAddress;

/**
 * Interface for the top-level proxy server class.
 */
public interface HttpProxyServer {

    int getIdleConnectionTimeout();

    void setIdleConnectionTimeout(int idleConnectionTimeout);

    /**
     * 
     * Clone the existing server, with a port 1 higher and everything else the
     * same. If the proxy was started with port 0 (JVM-assigned port), the cloned proxy will also use a JVM-assigned
     * port.
     * 
     * 
     * 
     * The new server will share event loops with the original server. The event
     * loops will use whatever name was given to the first server in the clone
     * group. The server group will not terminate until the original server and all clones terminate.
     * 
     * 
     * @return a bootstrap that allows customizing and starting the cloned
     *         server
     */
    HttpProxyServerBootstrap clone();

    /**
     * Stops the server and all related clones. Waits for traffic to stop before shutting down.
     */
    void stop();

    /**
     * Stops the server and all related clones immediately, without waiting for traffic to stop.
     */
    void abort();

    /**
     * Return the address on which this proxy is listening.
     * 
     * @return
     */
    InetSocketAddress getListenAddress();

    /**
     * 
     * Set the read/write throttle bandwidths (in bytes/second) for this proxy.
     * 
     * @param readThrottleBytesPerSecond
     * @param writeThrottleBytesPerSecond
     */
    void setThrottle(long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond);
}