stream_engine_base.hpp 5.66 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3

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

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

30 31
#ifndef __ZMQ_STREAM_ENGINE_BASE_HPP_INCLUDED__
#define __ZMQ_STREAM_ENGINE_BASE_HPP_INCLUDED__
32

33 34
#include <stddef.h>

35
#include "fd.hpp"
36
#include "i_engine.hpp"
37
#include "io_object.hpp"
38 39
#include "i_encoder.hpp"
#include "i_decoder.hpp"
40
#include "options.hpp"
41
#include "socket_base.hpp"
42
#include "metadata.hpp"
43
#include "msg.hpp"
44
#include "tcp.hpp"
45 46 47

namespace zmq
{
48 49 50
class io_thread_t;
class session_base_t;
class mechanism_t;
51

52 53
//  This engine handles any socket with SOCK_STREAM semantics,
//  e.g. TCP socket or an UNIX domain socket.
54

55
class stream_engine_base_t : public io_object_t, public i_engine
56 57
{
  public:
58 59 60 61
    stream_engine_base_t (fd_t fd_,
                          const options_t &options_,
                          const endpoint_uri_pair_t &endpoint_uri_pair_);
    ~stream_engine_base_t ();
62

63 64 65
    //  i_engine interface implementation.
    void plug (zmq::io_thread_t *io_thread_, zmq::session_base_t *session_);
    void terminate ();
66
    bool restart_input ();
67 68
    void restart_output ();
    void zap_msg_available ();
69
    const endpoint_uri_pair_t &get_endpoint () const;
70

71 72 73 74
    //  i_poll_events interface implementation.
    void in_event ();
    void out_event ();
    void timer_event (int id_);
75

76 77 78
  protected:
    typedef metadata_t::dict_t properties_t;
    bool init_properties (properties_t &properties_);
79

80
    //  Function to handle network disconnections.
81
    virtual void error (error_reason_t reason_);
82

83 84
    int next_handshake_command (msg_t *msg_);
    int process_handshake_command (msg_t *msg_);
85

86
    int pull_msg_from_session (msg_t *msg_);
87
    int push_msg_to_session (msg_t *msg_);
88

89 90
    int pull_and_encode (msg_t *msg_);
    int decode_and_push (msg_t *msg_);
91

92
    void set_handshake_timer ();
93
    int tcp_read (void *data_, size_t size_);
Thomas Rodgers's avatar
Thomas Rodgers committed
94

95 96
    virtual bool handshake () { return true; };
    virtual void plug_internal (){};
Jonathan Reams's avatar
Jonathan Reams committed
97

98 99 100 101
    virtual int process_command_message (msg_t *msg_) { return -1; };
    virtual int produce_ping_message (msg_t *msg_) { return -1; };
    virtual int process_heartbeat_message (msg_t *msg_) { return -1; };
    virtual int produce_pong_message (msg_t *msg_) { return -1; };
102

103 104 105 106
    void set_pollout () { io_object_t::set_pollout (_handle); }
    void set_pollin () { io_object_t::set_pollin (_handle); }
    session_base_t *session () { return _session; }
    socket_base_t *socket () { return _socket; }
107

108
    const options_t _options;
109

110 111 112
    unsigned char *_inpos;
    size_t _insize;
    i_decoder *_decoder;
113

114 115 116
    unsigned char *_outpos;
    size_t _outsize;
    i_encoder *_encoder;
117

118
    mechanism_t *_mechanism;
119

120 121
    int (stream_engine_base_t::*_next_msg) (msg_t *msg_);
    int (stream_engine_base_t::*_process_msg) (msg_t *msg_);
122

123 124
    //  Metadata to be attached to received messages. May be NULL.
    metadata_t *_metadata;
125

126
    //  True iff the engine couldn't consume the last decoded message.
127
    bool _input_stopped;
128

129
    //  True iff the engine doesn't have any message to encode.
130
    bool _output_stopped;
131

132 133 134
    //  Representation of the connected endpoints.
    const endpoint_uri_pair_t _endpoint_uri_pair;

135 136 137 138 139
    //  ID of the handshake timer
    enum
    {
        handshake_timer_id = 0x40
    };
140

141
    //  True is linger timer is running.
142
    bool _has_handshake_timer;
Jonathan Reams's avatar
Jonathan Reams committed
143

144 145 146 147 148 149 150
    //  Heartbeat stuff
    enum
    {
        heartbeat_ivl_timer_id = 0x80,
        heartbeat_timeout_timer_id = 0x81,
        heartbeat_ttl_timer_id = 0x82
    };
151 152 153
    bool _has_ttl_timer;
    bool _has_timeout_timer;
    bool _has_heartbeat_timer;
154

155

156
    const std::string _peer_address;
157

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
  private:
    bool in_event_internal ();

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

    int write_credential (msg_t *msg_);
    int push_one_then_decode_and_push (msg_t *msg_);

    void mechanism_ready ();

    //  Underlying socket.
    fd_t _s;

    handle_t _handle;

    bool _plugged;

    //  When true, we are still trying to determine whether
    //  the peer is using versioned protocol, and if so, which
    //  version.  When false, normal message flow has started.
    bool _handshaking;

    msg_t _tx_msg;

    bool _io_error;

    //  The session this engine is attached to.
    zmq::session_base_t *_session;

    // Socket
    zmq::socket_base_t *_socket;

    stream_engine_base_t (const stream_engine_base_t &);
    const stream_engine_base_t &operator= (const stream_engine_base_t &);
193
};
194 195 196
}

#endif