org.netcrusher.NetCrusher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of netcrusher-core Show documentation

NetCrusher is a TCP/UDP proxy that allows yout to test your services for failover

The newest version!

package org.netcrusher;

import org.netcrusher.core.meter.RateMeters;

import java.io.Closeable;
import java.net.InetSocketAddress;
import java.util.Collection;

public interface NetCrusher extends NetFreezer, Closeable {

    /**
     * Opens the crusher and it's sockets
     * @throws IllegalStateException Throwed if the crusher is already open
     * @see NetCrusher#close()
     * @see NetCrusher#isOpen()
     */
    void open();

    /**
     * Closes the crusher and it's sockets. After the crusher is closed it can be reopen again
     * @see NetCrusher#open()
     * @see NetCrusher#isOpen()
     */
    @Override
    void close();

    /**
     * Closes and then reopens the crusher again
     * @throws IllegalStateException Throwed if the crusher is not open
     * @see NetCrusher#open()
     * @see NetCrusher#close()
     */
    void reopen();

    /**
     * Checks is the crusher open
     * @return Return true if the crusher is open
     * @see NetCrusher#open()
     * @see NetCrusher#close()
     */
    boolean isOpen();

    /**
     * Get the address which is used to bind on
     * @return Local bind addresss
     */
    InetSocketAddress getBindAddress();

    /**
     * Get the adress which is used to connect to
     * @return Remote connect address
     */
    InetSocketAddress getConnectAddress();

    /**
     * Get addresses of clients which are connected to the crusher
     * @return Collection of addresses
     */
    Collection getClientAddresses();

    /**
     * Get byte statistics for the specified client address
     * @param clientAddress Client address
     * @return Statistic for the specified client address or null if such client is not found
     */
    RateMeters getClientByteMeters(InetSocketAddress clientAddress);

    /**
     * Close facilities for the specified client
     * @param clientAddress Client address
     * @return Return true if client is closed, return false if client is not found
     */
    boolean closeClient(InetSocketAddress clientAddress);

    /**
     * Get the total number of registered client since last crusher opening
     * @return Total number of clients
     */
    int getClientTotalCount();

}