socket_poller.hpp 4.25 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

    This file is part of libzmq, the ZeroMQ core engine in C++.

    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
    (at your option) any later version.

    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.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __ZMQ_SOCKET_POLLER_HPP_INCLUDED__
#define __ZMQ_SOCKET_POLLER_HPP_INCLUDED__

33 34
#include "poller.hpp"

35
#if defined ZMQ_POLL_BASED_ON_POLL && !defined ZMQ_HAVE_WINDOWS
36 37 38 39 40
#include <poll.h>
#endif

#if defined ZMQ_HAVE_WINDOWS
#include "windows.hpp"
41 42 43 44
#elif defined ZMQ_HAVE_VXWORKS
#include <unistd.h>
#include <sys/time.h>
#include <strings.h>
45 46 47 48
#else
#include <unistd.h>
#endif

49 50
#include <vector>

51 52
#include "socket_base.hpp"
#include "signaler.hpp"
53 54 55

namespace zmq
{
56 57 58 59 60
class socket_poller_t
{
  public:
    socket_poller_t ();
    ~socket_poller_t ();
61

62
    typedef struct event_t
63
    {
64 65 66 67 68
        socket_base_t *socket;
        fd_t fd;
        void *user_data;
        short events;
    } event_t;
69

70 71 72
    int add (socket_base_t *socket, void *user_data, short events);
    int modify (socket_base_t *socket, short events);
    int remove (socket_base_t *socket);
73

74 75 76
    int add_fd (fd_t fd, void *user_data, short events);
    int modify_fd (fd_t fd, short events);
    int remove_fd (fd_t fd);
77

78
    int wait (event_t *event, int n_events, long timeout);
79

80
    inline int size (void) { return static_cast<int> (items.size ()); };
81

82 83
    //  Return false if object is not a socket.
    bool check_tag ();
84

85 86 87 88
  private:
    void zero_trail_events (zmq::socket_poller_t::event_t *events_,
                            int n_events_,
                            int found);
89
#if defined ZMQ_POLL_BASED_ON_POLL
90
    int check_events (zmq::socket_poller_t::event_t *events_, int n_events_);
91
#elif defined ZMQ_POLL_BASED_ON_SELECT
92 93 94 95 96
    int check_events (zmq::socket_poller_t::event_t *events_,
                      int n_events_,
                      fd_set &inset,
                      fd_set &outset,
                      fd_set &errset);
97
#endif
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    int adjust_timeout (zmq::clock_t &clock,
                        long timeout_,
                        uint64_t &now,
                        uint64_t &end,
                        bool &first_pass);
    void rebuild ();

    //  Used to check whether the object is a socket_poller.
    uint32_t tag;

    //  Signaler used for thread safe sockets polling
    signaler_t *signaler;

    typedef struct item_t
    {
        socket_base_t *socket;
        fd_t fd;
        void *user_data;
        short events;
117
#if defined ZMQ_POLL_BASED_ON_POLL
118
        int pollfd_index;
119
#endif
120
    } item_t;
121

122 123 124
    //  List of sockets
    typedef std::vector<item_t> items_t;
    items_t items;
125

126 127
    //  Does the pollset needs rebuilding?
    bool need_rebuild;
128

129 130
    //  Should the signaler be used for the thread safe polling?
    bool use_signaler;
131

132 133
    //  Size of the pollset
    int poll_size;
134

135
#if defined ZMQ_POLL_BASED_ON_POLL
136
    pollfd *pollfds;
137
#elif defined ZMQ_POLL_BASED_ON_SELECT
138 139 140 141
    fd_set pollset_in;
    fd_set pollset_out;
    fd_set pollset_err;
    zmq::fd_t maxfd;
142
#endif
143

144 145 146
    socket_poller_t (const socket_poller_t &);
    const socket_poller_t &operator= (const socket_poller_t &);
};
147 148 149
}

#endif