epoll.hpp 3.15 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_EPOLL_HPP_INCLUDED__
#define __ZMQ_EPOLL_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_EPOLL
Martin Sustrik's avatar
Martin Sustrik committed
36 37

#include <vector>
38 39 40 41

#if defined ZMQ_HAVE_WINDOWS
#include "../external/wepoll/wepoll.h"
#else
Martin Sustrik's avatar
Martin Sustrik committed
42
#include <sys/epoll.h>
43
#endif
Martin Sustrik's avatar
Martin Sustrik committed
44

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

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

55 56
//  This class implements socket polling mechanism using the Linux-specific
//  epoll mechanism.
57

58
class epoll_t : public worker_poller_base_t
59 60 61
{
  public:
    typedef void *handle_t;
Martin Sustrik's avatar
Martin Sustrik committed
62

63
    epoll_t (const thread_ctx_t &ctx_);
64
    ~epoll_t ();
65

66 67 68 69 70 71 72 73
    //  "poller" concept.
    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
74

75
    static int max_fds ();
Martin Sustrik's avatar
Martin Sustrik committed
76

77
  private:
78 79 80 81 82 83 84 85 86 87 88
#if defined ZMQ_HAVE_WINDOWS
    typedef HANDLE epoll_fd_t;
    static const epoll_fd_t epoll_retired_fd;
#else
    typedef fd_t epoll_fd_t;
    enum
    {
        epoll_retired_fd = retired_fd
    };
#endif

89 90
    //  Main event loop.
    void loop ();
91

92
    //  Main epoll file descriptor
93
    epoll_fd_t _epoll_fd;
Martin Sustrik's avatar
Martin Sustrik committed
94

95 96 97 98 99 100
    struct poll_entry_t
    {
        fd_t fd;
        epoll_event ev;
        zmq::i_poll_events *events;
    };
Martin Sustrik's avatar
Martin Sustrik committed
101

102 103
    //  List of retired event sources.
    typedef std::vector<poll_entry_t *> retired_t;
104
    retired_t _retired;
Martin Sustrik's avatar
Martin Sustrik committed
105

106
    //  Handle of the physical thread doing the I/O work.
107
    thread_t _worker;
108

109 110 111
    epoll_t (const epoll_t &);
    const epoll_t &operator= (const epoll_t &);
};
112

113
typedef epoll_t poller_t;
Martin Sustrik's avatar
Martin Sustrik committed
114 115 116 117 118
}

#endif

#endif