sirius.web.http.ActiveHTTPConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirius-web Show documentation

Provides a modern and scalable web server as SIRIUS module

There is a newer version: 22.2.3

/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.web.http;

/**
 * Used by {@link WebServer#getOpenConnections()} to provide detailed information about an open HTTP connection.
 */
public interface ActiveHTTPConnection {

    /**
     * Returns the number of keep-alives performed on this connection.
     *
     * @return the number of keep-alives performed (received and accepted)
     */
    int getNumKeepAlive();

    /**
     * Returns the url currently being processed.
     *
     * @return the url currently being processed
     */
    String getURL();

    /**
     * Returns the duration of the connection.
     *
     * @return the duration of the connection in seconds
     */
    String getConnectedSince();

    /**
     * Returns the number of bytes received.
     *
     * @return the number of bytes received via this connection
     */
    String getBytesIn();

    /**
     * Returns the number of bytes send.
     *
     * @return the number of bytes sent via this connection
     */
    String getBytesOut();

    /**
     * Returns the uplink (incoming) bandwidth.
     *
     * @return the incoming bandwidth
     */
    String getUplink();

    /**
     * Returns the downlink (outgoing) bandwidth.
     *
     * @return the outgoing bandwidth
     */
    String getDownlink();

    /**
     * Returns the remote address which opened the connection.
     *
     * @return the remote address which opened the connection
     */
    String getRemoteAddress();

    /**
     * Returns latency information as a pair of numbers like "8ms / 5ms".
     * 
     * The first of those number is how long the server has been waiting for a chunk to arrive at the server.
     * The second one is the (blocking) time it takes to process this chunk.
     *
     * @return a latency string like "8ms / 5ms"
     */
    String getLatency();
}