zmq.Config Maven / Gradle / Ivy

Go to download
package zmq;

public enum Config
{
    //  Number of new messages in message pipe needed to trigger new memory
    //  allocation. Setting this parameter to 256 decreases the impact of
    //  memory allocation by approximately 99.6%
    MESSAGE_PIPE_GRANULARITY(256),

    //  Commands in pipe per allocation event.
    COMMAND_PIPE_GRANULARITY(16),

    //  Determines how often does socket poll for new commands when it
    //  still has unprocessed messages to handle. Thus, if it is set to 100,
    //  socket will process 100 inbound messages before doing the poll.
    //  If there are no unprocessed messages available, poll is done
    //  immediately. Decreasing the value trades overall latency for more
    //  real-time behaviour (less latency peaks).
    INBOUND_POLL_RATE(100),

    //  Maximal batching size for engines with receiving functionality.
    //  So, if there are 10 messages that fit into the batch size, all of
    //  them may be read by a single 'recv' system call, thus avoiding
    //  unnecessary network stack traversals.
    IN_BATCH_SIZE(8192),

    //  Maximal batching size for engines with sending functionality.
    //  So, if there are 10 messages that fit into the batch size, all of
    //  them may be written by a single 'send' system call, thus avoiding
    //  unnecessary network stack traversals.
    OUT_BATCH_SIZE(8192),

    //  Maximal delta between high and low watermark.
    MAX_WM_DELTA(1024),

    //  Maximum number of events the I/O thread can process in one go.
    MAX_IO_EVENTS(256),

    //  Maximal delay to process command in API thread (in CPU ticks).
    //  3,000,000 ticks equals to 1 - 2 milliseconds on current CPUs.
    //  Note that delay is only applied when there is continuous stream of
    //  messages to process. If not so, commands are processed immediately.
    MAX_COMMAND_DELAY(3000000),

    //  Low-precision clock precision in CPU ticks. 1ms. Value of 1000000
    //  should be OK for CPU frequencies above 1GHz. If should work
    //  reasonably well for CPU frequencies above 500MHz. For lower CPU
    //  frequencies you may consider lowering this value to get best
    //  possible latencies.
    CLOCK_PRECISION(1000000),

    //  Maximum transport data unit size for PGM (TPDU).
    PGM_MAX_TPDU(1500),

    //  On some OSes the signaler has to be emulated using a TCP
    //  connection. In such cases following port is used.
    //  If 0, it lets the OS choose a free port without requiring use of a
    //  global mutex. The original implementation of a Windows signaler
    //  socket used port 5905 instead of letting the OS choose a free port.
    //  https://github.com/zeromq/libzmq/issues/1542
    SIGNALER_PORT(0),

    // Threshold of message size for choosing if message data should
    // be allocated on heap or on direct memory.
    // This has a direct impact on transmission of large messages
    MSG_ALLOCATION_HEAP_THRESHOLD(1024 * 1024);

    private final int value;

    Config(int value)
    {
        this.value = value;
    }

    public int getValue()
    {
        return value;
    }
}