io.questdb.network.IODispatcherConfiguration Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 *     ___                  _   ____  ____
 *    / _ \ _   _  ___  ___| |_|  _ \| __ )
 *   | | | | | | |/ _ \/ __| __| | | |  _ \
 *   | |_| | |_| |  __/\__ \ |_| |_| | |_) |
 *    \__\_\\__,_|\___||___/\__|____/|____/
 *
 *  Copyright (c) 2014-2019 Appsicle
 *  Copyright (c) 2019-2022 QuestDB
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 ******************************************************************************/

package io.questdb.network;

import io.questdb.std.Numbers;
import io.questdb.std.Os;
import io.questdb.std.datetime.millitime.MillisecondClock;

public interface IODispatcherConfiguration {
    int BIAS_READ = 1;
    int BIAS_WRITE = 2;

    int getLimit();

    int getBindIPv4Address();

    int getBindPort();

    MillisecondClock getClock();

    default String getDispatcherLogName() {
        return "IODispatcher";
    }

    EpollFacade getEpollFacade();

    default int getEventCapacity() {
        return Numbers.ceilPow2(getLimit());
    }

    default int getIOQueueCapacity() {
        return Numbers.ceilPow2(getLimit());
    }

    long getTimeout();

    int getInitialBias();

    default int getInterestQueueCapacity() {
        return Numbers.ceilPow2(getLimit());
    }

    default boolean getHint() {
        return false;
    }

    default int getListenBacklog() {
        if (Os.type == Os.WINDOWS && getHint()) {
            // Windows OS might have a limit of 200 concurrent connections. To overcome
            // this limit we set backlog value to a hint as described here:
            /// https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen
            // the hint is -backlog
            return -getLimit();
        }
        return getLimit();
    }

    NetworkFacade getNetworkFacade();

    default boolean getPeerNoLinger() {
        return false;
    }

    int getRcvBufSize();

    SelectFacade getSelectFacade();

    int getSndBufSize();

    long getQueueTimeout();
}