io_thread.hpp 3.09 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_IO_THREAD_HPP_INCLUDED__
#define __ZMQ_IO_THREAD_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32 33 34

#include <vector>

35
#include "stdint.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
36
#include "object.hpp"
37
#include "poller.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
38
#include "i_poll_events.hpp"
39
#include "mailbox.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
40

Martin Sustrik's avatar
Martin Sustrik committed
41
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
42 43
{

44 45
    class ctx_t;

Martin Sustrik's avatar
Martin Sustrik committed
46 47 48
    //  Generic part of the I/O thread. Polling-mechanism-specific features
    //  are implemented in separate "polling objects".

49
    class io_thread_t : public object_t, public i_poll_events
Martin Sustrik's avatar
Martin Sustrik committed
50 51 52
    {
    public:

53
        io_thread_t (zmq::ctx_t *ctx_, uint32_t tid_);
Martin Sustrik's avatar
Martin Sustrik committed
54

55
        //  Clean-up. If the thread was started, it's necessary to call 'stop'
56 57 58
        //  before invoking destructor. Otherwise the destructor would hang up.
        ~io_thread_t ();

Martin Sustrik's avatar
Martin Sustrik committed
59 60 61 62 63 64
        //  Launch the physical thread.
        void start ();

        //  Ask underlying thread to stop.
        void stop ();

65 66
        //  Returns mailbox associated with this I/O thread.
        mailbox_t *get_mailbox ();
Martin Sustrik's avatar
Martin Sustrik committed
67 68 69 70

        //  i_poll_events implementation.
        void in_event ();
        void out_event ();
71
        void timer_event (int id_);
Martin Sustrik's avatar
Martin Sustrik committed
72

73
        //  Used by io_objects to retrieve the associated poller object.
74
        poller_t *get_poller ();
Martin Sustrik's avatar
Martin Sustrik committed
75 76 77 78 79 80 81 82 83

        //  Command handlers.
        void process_stop ();

        //  Returns load experienced by the I/O thread.
        int get_load ();

    private:

84 85
        //  I/O thread accesses incoming commands via this mailbox.
        mailbox_t mailbox;
Martin Sustrik's avatar
Martin Sustrik committed
86

87 88
        //  Handle associated with mailbox' file descriptor.
        poller_t::handle_t mailbox_handle;
Martin Sustrik's avatar
Martin Sustrik committed
89 90

        //  I/O multiplexing is performed using a poller object.
91
        poller_t *poller;
92 93 94

        io_thread_t (const io_thread_t&);
        const io_thread_t &operator = (const io_thread_t&);
Martin Sustrik's avatar
Martin Sustrik committed
95 96 97 98 99
    };

}

#endif