select.hpp 3.73 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_SELECT_HPP_INCLUDED__
#define __ZMQ_SELECT_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

33 34 35 36
//  poller.hpp decides which polling mechanism to use.
#include "poller.hpp"
#if defined ZMQ_USE_SELECT

Martin Sustrik's avatar
Martin Sustrik committed
37 38 39 40 41
#include "platform.hpp"

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

Martin Sustrik's avatar
Martin Sustrik committed
42
#ifdef ZMQ_HAVE_WINDOWS
43
#include <winsock2.h>
Martin Sustrik's avatar
Martin Sustrik committed
44
#elif defined ZMQ_HAVE_OPENVMS
Martin Sustrik's avatar
Martin Sustrik committed
45 46 47 48 49 50
#include <sys/types.h>
#include <sys/time.h>
#else
#include <sys/select.h>
#endif

51
#include "ctx.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
52 53
#include "fd.hpp"
#include "thread.hpp"
54
#include "poller_base.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
55

Martin Sustrik's avatar
Martin Sustrik committed
56
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
57 58
{

59 60
    struct i_poll_events;

Martin Sustrik's avatar
Martin Sustrik committed
61 62 63
    //  Implements socket polling mechanism using POSIX.1-2001 select()
    //  function.

64
    class select_t : public poller_base_t
Martin Sustrik's avatar
Martin Sustrik committed
65 66 67
    {
    public:

68 69
        typedef fd_t handle_t;

70
        select_t (const ctx_t &ctx_);
71
        ~select_t ();
Martin Sustrik's avatar
Martin Sustrik committed
72

73
        //  "poller" concept.
74
        handle_t add_fd (fd_t fd_, zmq::i_poll_events *events_);
Martin Sustrik's avatar
Martin Sustrik committed
75 76 77 78 79 80 81 82
        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
83
        static int max_fds ();
84

Martin Sustrik's avatar
Martin Sustrik committed
85 86 87 88 89 90 91 92
    private:

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

        //  Main event loop.
        void loop ();

93 94 95
        // Reference to ZMQ context.
        const ctx_t &ctx;

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

102 103 104
        //  Checks if an fd_entry_t is retired.
        static bool is_retired_fd (const fd_entry_t &entry);

105
        //  Set of file descriptors that are used to retrieve
Martin Sustrik's avatar
Martin Sustrik committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
        //  information for fd_set.
        typedef std::vector <fd_entry_t> fd_set_t;
        fd_set_t fds;

        fd_set source_set_in;
        fd_set source_set_out;
        fd_set source_set_err;

        fd_set readfds;
        fd_set writefds;
        fd_set exceptfds;

        //  Maximum file descriptor.
        fd_t maxfd;

        //  If true, at least one file descriptor has retired.
        bool retired;

        //  If true, thread is shutting down.
        bool stopping;

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

        select_t (const select_t&);
131
        const select_t &operator = (const select_t&);
Martin Sustrik's avatar
Martin Sustrik committed
132 133
    };

134 135
    typedef select_t poller_t;

Martin Sustrik's avatar
Martin Sustrik committed
136 137 138 139
}

#endif

140
#endif