poll.hpp 3.28 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_POLL_HPP_INCLUDED__
#define __ZMQ_POLL_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

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

37 38 39 40
#if defined ZMQ_HAVE_WINDOWS
#error                                                                         \
  "poll is broken on Windows for the purpose of the I/O thread poller, use select instead; "\
  "see https://github.com/zeromq/libzmq/issues/3107"
41
#endif
42 43

#include <poll.h>
Martin Sustrik's avatar
Martin Sustrik committed
44 45 46
#include <stddef.h>
#include <vector>

47
#include "ctx.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
48 49
#include "fd.hpp"
#include "thread.hpp"
50
#include "poller_base.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
51

Martin Sustrik's avatar
Martin Sustrik committed
52
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
53
{
54
struct i_poll_events;
Martin Sustrik's avatar
Martin Sustrik committed
55

56 57
//  Implements socket polling mechanism using the POSIX.1-2001
//  poll() system call.
58

59
class poll_t : public worker_poller_base_t
60 61 62
{
  public:
    typedef fd_t handle_t;
Martin Sustrik's avatar
Martin Sustrik committed
63

64
    poll_t (const thread_ctx_t &ctx_);
65
    ~poll_t ();
66

67
    //  "poller" concept.
68
    //  These methods may only be called from an event callback; add_fd may also be called before start.
69 70 71 72 73 74 75
    handle_t add_fd (fd_t fd_, zmq::i_poll_events *events_);
    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 stop ();
Martin Sustrik's avatar
Martin Sustrik committed
76

77
    static int max_fds ();
Martin Sustrik's avatar
Martin Sustrik committed
78

79 80
  private:
    //  Main event loop.
81
    virtual void loop ();
82

83
    void cleanup_retired ();
Martin Sustrik's avatar
Martin Sustrik committed
84

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

91 92 93
    //  This table stores data for registered descriptors.
    typedef std::vector<fd_entry_t> fd_table_t;
    fd_table_t fd_table;
Martin Sustrik's avatar
Martin Sustrik committed
94

95 96 97
    //  Pollset to pass to the poll function.
    typedef std::vector<pollfd> pollset_t;
    pollset_t pollset;
Martin Sustrik's avatar
Martin Sustrik committed
98

99 100
    //  If true, there's at least one retired event source.
    bool retired;
Martin Sustrik's avatar
Martin Sustrik committed
101

102 103 104
    poll_t (const poll_t &);
    const poll_t &operator= (const poll_t &);
};
105

106
typedef poll_t poller_t;
Martin Sustrik's avatar
Martin Sustrik committed
107 108 109 110 111
}

#endif

#endif