select.hpp 2.99 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2014 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3 4 5 6

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
7
    the terms of the GNU Lesser General Public License as published by
Martin Sustrik's avatar
Martin Sustrik committed
8 9 10 11 12 13
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    0MQ 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
14
    GNU Lesser General Public License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
15

16
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
17 18 19
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
20 21
#ifndef __ZMQ_SELECT_HPP_INCLUDED__
#define __ZMQ_SELECT_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
22

23 24 25 26
//  poller.hpp decides which polling mechanism to use.
#include "poller.hpp"
#if defined ZMQ_USE_SELECT

Martin Sustrik's avatar
Martin Sustrik committed
27 28 29 30 31
#include "platform.hpp"

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

Martin Sustrik's avatar
Martin Sustrik committed
32
#ifdef ZMQ_HAVE_WINDOWS
33
#include <winsock2.h>
Martin Sustrik's avatar
Martin Sustrik committed
34
#elif defined ZMQ_HAVE_OPENVMS
Martin Sustrik's avatar
Martin Sustrik committed
35 36 37 38 39 40 41 42
#include <sys/types.h>
#include <sys/time.h>
#else
#include <sys/select.h>
#endif

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

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

48 49
    struct i_poll_events;

Martin Sustrik's avatar
Martin Sustrik committed
50 51 52
    //  Implements socket polling mechanism using POSIX.1-2001 select()
    //  function.

53
    class select_t : public poller_base_t
Martin Sustrik's avatar
Martin Sustrik committed
54 55 56
    {
    public:

57 58
        typedef fd_t handle_t;

Martin Sustrik's avatar
Martin Sustrik committed
59
        select_t ();
60
        ~select_t ();
Martin Sustrik's avatar
Martin Sustrik committed
61

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

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

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

        //  Main event loop.
        void loop ();

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

88 89 90
        //  Checks if an fd_entry_t is retired.
        static bool is_retired_fd (const fd_entry_t &entry);

Martin Sustrik's avatar
Martin Sustrik committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
        //  Set of file descriptors that are used to retreive
        //  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&);
117
        const select_t &operator = (const select_t&);
Martin Sustrik's avatar
Martin Sustrik committed
118 119
    };

120 121
    typedef select_t poller_t;

Martin Sustrik's avatar
Martin Sustrik committed
122 123 124 125
}

#endif

126
#endif