poll.hpp 3.34 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2015 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_POLL_HPP_INCLUDED__
#define __ZMQ_POLL_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_POLL
Martin Sustrik's avatar
Martin Sustrik committed
36 37 38 39 40

#include <poll.h>
#include <stddef.h>
#include <vector>

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

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

49 50
    struct i_poll_events;

Martin Sustrik's avatar
Martin Sustrik committed
51 52 53
    //  Implements socket polling mechanism using the POSIX.1-2001
    //  poll() system call.

54
    class poll_t : public poller_base_t
Martin Sustrik's avatar
Martin Sustrik committed
55 56 57
    {
    public:

58 59
        typedef fd_t handle_t;

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

63
        //  "poller" concept.
64
        handle_t add_fd (fd_t fd_, zmq::i_poll_events *events_);
Martin Sustrik's avatar
Martin Sustrik committed
65 66 67 68 69 70 71 72
        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
73
        static int max_fds ();
74

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

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

        //  Main event loop.
        void loop ();

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

Martin Sustrik's avatar
Martin Sustrik committed
86 87 88
        struct fd_entry_t
        {
            fd_t index;
89
            zmq::i_poll_events *events;
Martin Sustrik's avatar
Martin Sustrik committed
90 91 92
        };

        //  This table stores data for registered descriptors.
93 94
        typedef std::vector <fd_entry_t> fd_table_t;
        fd_table_t fd_table;
Martin Sustrik's avatar
Martin Sustrik committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

        //  Pollset to pass to the poll function.
        typedef std::vector <pollfd> pollset_t;
        pollset_t pollset;

        //  If true, there's at least one retired event source.
        bool 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;

        poll_t (const poll_t&);
110
        const poll_t &operator = (const poll_t&);
Martin Sustrik's avatar
Martin Sustrik committed
111 112
    };

113 114
    typedef poll_t poller_t;

Martin Sustrik's avatar
Martin Sustrik committed
115 116 117 118 119
}

#endif

#endif