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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of littleproxy Show documentation

LittleProxy is a high performance HTTP proxy written in Java and using the Netty networking framework.

There is a newer version: 1.1.2

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.
     * 
     * 
     * 
     * 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.
     * 
     * 
     * @return a bootstrap that allows customizing and starting the cloned
     *         server
     */
    HttpProxyServerBootstrap clone();

    /**
     * Stops the server and all related clones.
     */
    void stop();

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