pgm_sender.hpp 3.57 KB
Newer Older
malosek's avatar
malosek committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
malosek's avatar
malosek committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
malosek's avatar
malosek 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
malosek's avatar
malosek 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.
malosek's avatar
malosek committed
25

26
    You should have received a copy of the GNU Lesser General Public License
malosek's avatar
malosek committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

malosek's avatar
malosek committed
30 31
#ifndef __ZMQ_PGM_SENDER_HPP_INCLUDED__
#define __ZMQ_PGM_SENDER_HPP_INCLUDED__
malosek's avatar
malosek committed
32

malosek's avatar
malosek committed
33
#if defined ZMQ_HAVE_OPENPGM
malosek's avatar
malosek committed
34 35 36 37 38 39

#include "stdint.hpp"
#include "io_object.hpp"
#include "i_engine.hpp"
#include "options.hpp"
#include "pgm_socket.hpp"
40
#include "v1_encoder.hpp"
41
#include "msg.hpp"
malosek's avatar
malosek committed
42 43 44 45

namespace zmq
{

46 47 48
    class io_thread_t;
    class session_base_t;

malosek's avatar
malosek committed
49 50 51 52
    class pgm_sender_t : public io_object_t, public i_engine
    {

    public:
Martin Sustrik's avatar
Martin Sustrik committed
53

54
        pgm_sender_t (zmq::io_thread_t *parent_, const options_t &options_);
malosek's avatar
malosek committed
55 56
        ~pgm_sender_t ();

57
        int init (bool udp_encapsulation_, const char *network_);
malosek's avatar
malosek committed
58 59

        //  i_engine interface implementation.
60 61
        void plug (zmq::io_thread_t *io_thread_,
            zmq::session_base_t *session_);
62
        void terminate ();
63 64
        void restart_input ();
        void restart_output ();
65
        void zap_msg_available () {}
66
        const char *get_endpoint () const;
malosek's avatar
malosek committed
67 68 69 70

        //  i_poll_events interface implementation.
        void in_event ();
        void out_event ();
71
        void timer_event (int token);
malosek's avatar
malosek committed
72 73 74

    private:

75 76 77
        //  Unplug the engine from the session.
        void unplug ();

78 79 80 81
        //  TX and RX timeout timer ID's.
        enum {tx_timer_id = 0xa0, rx_timer_id = 0xa1};

        //  Timers are running.
82 83
        bool has_tx_timer;
        bool has_rx_timer;
84

85 86
        session_base_t *session;

malosek's avatar
malosek committed
87
        //  Message encoder.
88
        v1_encoder_t encoder;
malosek's avatar
malosek committed
89

90 91 92 93 94
        msg_t msg;

        //  Keeps track of message boundaries.
        bool more_flag;

malosek's avatar
malosek committed
95 96 97 98 99 100 101 102 103
        //  PGM socket.
        pgm_socket_t pgm_socket;

        //  Socket options.
        options_t options;

        //  Poll handle associated with PGM socket.
        handle_t handle;
        handle_t uplink_handle;
malosek's avatar
malosek committed
104
        handle_t rdata_notify_handle;
105
        handle_t pending_notify_handle;
malosek's avatar
malosek committed
106 107 108

        //  Output buffer from pgm_socket.
        unsigned char *out_buffer;
109

malosek's avatar
malosek committed
110 111 112
        //  Output buffer size.
        size_t out_buffer_size;

Martin Sustrik's avatar
Martin Sustrik committed
113 114
        //  Number of bytes in the buffer to be written to the socket.
        //  If zero, there are no data to be sent.
malosek's avatar
malosek committed
115 116 117
        size_t write_size;

        pgm_sender_t (const pgm_sender_t&);
118
        const pgm_sender_t &operator = (const pgm_sender_t&);
malosek's avatar
malosek committed
119 120 121 122 123 124
    };

}
#endif

#endif