config.hpp 4.26 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq 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 Lesser General Public
    License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
30 31
#ifndef __ZMQ_CONFIG_HPP_INCLUDED__
#define __ZMQ_CONFIG_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

Martin Sustrik's avatar
Martin Sustrik committed
33
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
34 35 36 37
{

    //  Compile-time settings.

38
    enum
Martin Sustrik's avatar
Martin Sustrik committed
39 40 41 42 43 44
    {
        //  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,

45 46 47
        //  Commands in pipe per allocation event.
        command_pipe_granularity = 16,

Martin Sustrik's avatar
Martin Sustrik committed
48 49 50 51 52 53 54 55
        //  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,

Martin Sustrik's avatar
Martin Sustrik committed
56 57 58 59 60 61
        //  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,

62 63 64 65 66 67
        //  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,

68 69
        //  Maximal delta between high and low watermark.
        max_wm_delta = 1024,
Martin Sustrik's avatar
Martin Sustrik committed
70 71 72 73 74 75

        //  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.
Martin Sustrik's avatar
Martin Sustrik committed
76 77
        //  Note that delay is only applied when there is continuous stream of
        //  messages to process. If not so, commands are processed immediately.
Martin Sustrik's avatar
Martin Sustrik committed
78 79
        max_command_delay = 3000000,

Martin Sustrik's avatar
Martin Sustrik committed
80 81
        //  Low-precision clock precision in CPU ticks. 1ms. Value of 1000000
        //  should be OK for CPU frequencies above 1GHz. If should work
Martin Sustrik's avatar
Martin Sustrik committed
82
        //  reasonably well for CPU frequencies above 500MHz. For lower CPU
Martin Sustrik's avatar
Martin Sustrik committed
83 84 85 86
        //  frequencies you may consider lowering this value to get best
        //  possible latencies.
        clock_precision = 1000000,

87 88
        //  On some OSes the signaler has to be emulated using a TCP
        //  connection. In such cases following port is used.
89 90
        //  If 0, it lets the OS choose a free port without requiring use of a
        //  global mutex. The original implementation of a Windows signaler
91 92 93
        //  socket used port 5905 instead of letting the OS choose a free port.
        //  https://github.com/zeromq/libzmq/issues/1542
        signaler_port = 0
Martin Sustrik's avatar
Martin Sustrik committed
94 95 96 97 98
    };

}

#endif