kqueue.hpp 3.59 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_KQUEUE_HPP_INCLUDED__
#define __ZMQ_KQUEUE_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

33 34 35
//  poller.hpp decides which polling mechanism to use.
#include "poller.hpp"
#if defined ZMQ_USE_KQUEUE
Martin Sustrik's avatar
Martin Sustrik committed
36 37

#include <vector>
38
#include <unistd.h>
Martin Sustrik's avatar
Martin Sustrik committed
39

40
#include "ctx.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
41 42
#include "fd.hpp"
#include "thread.hpp"
43
#include "poller_base.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
44

Martin Sustrik's avatar
Martin Sustrik committed
45
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
46 47
{

48 49
    struct i_poll_events;

Martin Sustrik's avatar
Martin Sustrik committed
50 51 52
    //  Implements socket polling mechanism using the BSD-specific
    //  kqueue interface.

53
    class kqueue_t : public poller_base_t
Martin Sustrik's avatar
Martin Sustrik committed
54 55 56
    {
    public:

57 58
        typedef void* handle_t;

59
        kqueue_t (const ctx_t &ctx_);
60
        ~kqueue_t ();
Martin Sustrik's avatar
Martin Sustrik committed
61

62
        //  "poller" concept.
63
        handle_t add_fd (fd_t fd_, zmq::i_poll_events *events_);
Martin Sustrik's avatar
Martin Sustrik committed
64 65 66 67 68 69 70 71
        void rm_fd (handle_t handle_);
        void set_pollin (handle_t handle_);
        void reset_pollin (handle_t handle_);
        void set_pollout (handle_t handle_);
        void reset_pollout (handle_t handle_);
        void start ();
        void stop ();

Richard Newton's avatar
Richard Newton committed
72
        static int max_fds ();
73

Martin Sustrik's avatar
Martin Sustrik committed
74 75 76 77 78 79 80 81
    private:

        //  Main worker thread routine.
        static void worker_routine (void *arg_);

        //  Main event loop.
        void loop ();

82 83 84
        // Reference to ZMQ context.
        const ctx_t &ctx;

Martin Sustrik's avatar
Martin Sustrik committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98
        //  File descriptor referring to the kernel event queue.
        fd_t kqueue_fd;

        //  Adds the event to the kqueue.
        void kevent_add (fd_t fd_, short filter_, void *udata_);

        //  Deletes the event from the kqueue.
        void kevent_delete (fd_t fd_, short filter_);

        struct poll_entry_t
        {
            fd_t fd;
            bool flag_pollin;
            bool flag_pollout;
99
            zmq::i_poll_events *reactor;
Martin Sustrik's avatar
Martin Sustrik committed
100 101 102 103 104 105 106 107 108 109 110 111 112
        };

        //  List of retired event sources.
        typedef std::vector <poll_entry_t*> retired_t;
        retired_t retired;

        //  If true, thread is in the process of shutting down.
        bool stopping;

        //  Handle of the physical thread doing the I/O work.
        thread_t worker;

        kqueue_t (const kqueue_t&);
113
        const kqueue_t &operator = (const kqueue_t&);
114 115 116 117 118

#ifdef HAVE_FORK
        // the process that created this context. Used to detect forking.
        pid_t pid;
#endif
Martin Sustrik's avatar
Martin Sustrik committed
119 120
    };

121 122
    typedef kqueue_t poller_t;

Martin Sustrik's avatar
Martin Sustrik committed
123 124 125 126 127
}

#endif

#endif