org.jsl.collider.Collider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of js-collider Show documentation
Java NIO framework
There is a newer version: 0.2.5
/*
 * Copyright (C) 2013 Sergey Zubarev, [email protected]
 *
 * This file is a part of JS-Collider framework.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package org.jsl.collider;

import java.io.IOException;
import java.net.NetworkInterface;
import java.nio.ByteOrder;

/* Collider public API. Typical usage example:
 * {@code
 * class ColliderApplication
 * {
 *     public static void main( String [] args )
 *     {
 *         try {
 *             final Collider collider = Collider.create();
 *             collider.run();
 *         }
 *         catch (IOException ex) {
 *             ex.printStackTrace();
 *         }
 *     }
 * }
 */

public abstract class Collider
{
    public static class Config
    {
        public int threadPoolThreads;
        public boolean useDirectBuffers;
        public ByteOrder byteOrder;

        public int socketSendBufSize;
        public int socketRecvBufSize;
        public int forwardReadMaxSize;
        public int inputQueueBlockSize;
        public int inputQueueCacheMaxSize;
        public int joinMessageMaxSize;
        public int datagramReadMinSize;

        public Config()
        {
            threadPoolThreads = 0; /* by default = number of cores */
            useDirectBuffers  = true;
            byteOrder = ByteOrder.nativeOrder();

            socketSendBufSize = 0; /* Use system default settings by default */
            socketRecvBufSize = 0; /* Use system default settings by default */

            forwardReadMaxSize     = (256 * 1024);
            inputQueueBlockSize    = (32 * 1024);
            inputQueueCacheMaxSize = 128;
            joinMessageMaxSize     = 0;
            datagramReadMinSize    = (2 * 1024);
        }
    }

    private final Config m_config;

    protected Collider( Config config )
    {
        m_config = config;
    }

    public final Config getConfig()
    {
        return m_config;
    }

    /**
     * Starts the collider.
     * Do not return the control back while collider is not stopped.
     */
    public abstract void run();

    /**
     * Stops the running collider.
     * The call is asynchronous, collider can still run some time.
     * At first all currently running acceptors and connectors will be removed.
     * After that all established sessions will be closed
     * (Session.Listener.onConnectionClose() will be called for each).
     * Only after that collider run loop stops and the thread running
     * Collider.run() function gets control back.
     */
    public abstract void stop();

    /**
     * Adds an Acceptor to the collider.
     * Additionally to the server socket exceptions
     * throws an IOException in a case if collider already stopped.
     * @param acceptor to add
     * @throws IOException as any underlying socket operation
     */
    public abstract void addAcceptor(Acceptor acceptor) throws IOException;

    /**
     * Removes the Acceptor from the collider.
     * On return guarantees that no one thread runs
     * Acceptor.onAcceptorStarted or Acceptor.createSessionListener.
     * @param acceptor to remove
     * @throws InterruptedException in a case if thread was interrupted while waiting
     */
    public abstract void removeAcceptor(Acceptor acceptor) throws InterruptedException;

    /**
     * Adds Connector to the collider.
     * Operation is asynchronous, socket operations can throw an exception,
     * Connector.onException will be called in this case in the collider thread pool,
     * better to handle it properly.
     * @param connector to add
     */
    public abstract void addConnector(Connector connector);
    public abstract void removeConnector(Connector connector) throws InterruptedException;

    public abstract void addDatagramListener(
            DatagramListener datagramListener ) throws IOException;

    public abstract void addDatagramListener(
            DatagramListener datagramListener,
            NetworkInterface networkInterface ) throws IOException;

    public abstract void removeDatagramListener(
            DatagramListener datagramListener ) throws InterruptedException;

    public abstract ThreadPool getThreadPool();

    /**
     * Create a Collider instance with default configuration.
     * @return new collider instance
     * @throws IOException as any underlying socket operation
     */
    public static Collider create() throws IOException
    {
        return create(new Config());
    }

    public static Collider create(Config config) throws IOException
    {
        return new ColliderImpl(config);
    }
}