io_object.hpp 2.25 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2014 Contributors as noted in the AUTHORS file
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
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.
15

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

#ifndef __ZMQ_IO_OBJECT_HPP_INCLUDED__
#define __ZMQ_IO_OBJECT_HPP_INCLUDED__

23 24
#include <stddef.h>

25
#include "stdint.hpp"
26
#include "poller.hpp"
27
#include "i_poll_events.hpp"
28 29 30 31

namespace zmq
{

32 33
    class io_thread_t;

34 35 36 37 38
    //  Simple base class for objects that live in I/O threads.
    //  It makes communication with the poller object easier and
    //  makes defining unneeded event handlers unnecessary.

    class io_object_t : public i_poll_events
39 40 41
    {
    public:

42
        io_object_t (zmq::io_thread_t *io_thread_ = NULL);
43
        ~io_object_t ();
44

45 46
        //  When migrating an object from one I/O thread to another, first
        //  unplug it, then migrate it, then plug it to the new thread.
47
        void plug (zmq::io_thread_t *io_thread_);
48 49
        void unplug ();

50 51
    protected:

52 53
        typedef poller_t::handle_t handle_t;

54
        //  Methods to access underlying poller object.
55
        handle_t add_fd (fd_t fd_);
56 57 58 59 60
        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_);
61 62
        void add_timer (int timout_, int id_);
        void cancel_timer (int id_);
63

64 65 66
        //  i_poll_events interface implementation.
        void in_event ();
        void out_event ();
67
        void timer_event (int id_);
68

69 70
    private:

71
        poller_t *poller;
72

73
        io_object_t (const io_object_t&);
74
        const io_object_t &operator = (const io_object_t&);
75 76 77 78 79
    };

}

#endif