socket_base.hpp 13.1 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 30 31 32
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __ZMQ_SOCKET_BASE_HPP_INCLUDED__
#define __ZMQ_SOCKET_BASE_HPP_INCLUDED__

33
#include <string>
34
#include <map>
35
#include <stdarg.h>
36

37
#include "own.hpp"
38
#include "array.hpp"
39
#include "blob.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
40
#include "stdint.hpp"
41 42
#include "poller.hpp"
#include "i_poll_events.hpp"
somdoron's avatar
somdoron committed
43
#include "i_mailbox.hpp"
44
#include "clock.hpp"
45
#include "pipe.hpp"
46
#include "endpoint.hpp"
47

48
extern "C" {
49
void zmq_free_event (void *data_, void *hint_);
50 51
}

52 53
namespace zmq
{
54 55 56 57 58 59 60 61 62 63 64 65 66
class ctx_t;
class msg_t;
class pipe_t;

class socket_base_t : public own_t,
                      public array_item_t<>,
                      public i_poll_events,
                      public i_pipe_events
{
    friend class reaper_t;

  public:
    //  Returns false if object is not a socket.
67
    bool check_tag () const;
68

69 70 71
    //  Returns whether the socket is thread-safe.
    bool is_thread_safe () const;

72 73 74 75 76
    //  Create a socket of a specified type.
    static socket_base_t *
    create (int type_, zmq::ctx_t *parent_, uint32_t tid_, int sid_);

    //  Returns the mailbox associated with this socket.
77
    i_mailbox *get_mailbox () const;
78 79 80 81 82 83 84 85

    //  Interrupt blocking call if the socket is stuck in one.
    //  This function can be called from a different thread!
    void stop ();

    //  Interface for communication with the API layer.
    int setsockopt (int option_, const void *optval_, size_t optvallen_);
    int getsockopt (int option_, void *optval_, size_t *optvallen_);
86 87 88
    int bind (const char *endpoint_uri_);
    int connect (const char *endpoint_uri_);
    int term_endpoint (const char *endpoint_uri_);
89 90
    int send (zmq::msg_t *msg_, int flags_);
    int recv (zmq::msg_t *msg_, int flags_);
91 92
    void add_signaler (signaler_t *s_);
    void remove_signaler (signaler_t *s_);
93 94 95 96 97 98 99 100
    int close ();

    //  These functions are used by the polling mechanism to determine
    //  which events are to be reported from this socket.
    bool has_in ();
    bool has_out ();

    //  Joining and leaving groups
101 102
    int join (const char *group_);
    int leave (const char *group_);
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

    //  Using this function reaper thread ask the socket to register with
    //  its poller.
    void start_reaping (poller_t *poller_);

    //  i_poll_events implementation. This interface is used when socket
    //  is handled by the poller in the reaper thread.
    void in_event ();
    void out_event ();
    void timer_event (int id_);

    //  i_pipe_events interface implementation.
    void read_activated (pipe_t *pipe_);
    void write_activated (pipe_t *pipe_);
    void hiccuped (pipe_t *pipe_);
    void pipe_terminated (pipe_t *pipe_);
    void lock ();
    void unlock ();

122
    int monitor (const char *endpoint_, uint64_t events_, int event_version_);
123

124 125 126 127 128
    void event_connected (const endpoint_uri_pair_t &endpoint_uri_pair_,
                          zmq::fd_t fd_);
    void event_connect_delayed (const endpoint_uri_pair_t &endpoint_uri_pair_,
                                int err_);
    void event_connect_retried (const endpoint_uri_pair_t &endpoint_uri_pair_,
129
                                int interval_);
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    void event_listening (const endpoint_uri_pair_t &endpoint_uri_pair_,
                          zmq::fd_t fd_);
    void event_bind_failed (const endpoint_uri_pair_t &endpoint_uri_pair_,
                            int err_);
    void event_accepted (const endpoint_uri_pair_t &endpoint_uri_pair_,
                         zmq::fd_t fd_);
    void event_accept_failed (const endpoint_uri_pair_t &endpoint_uri_pair_,
                              int err_);
    void event_closed (const endpoint_uri_pair_t &endpoint_uri_pair_,
                       zmq::fd_t fd_);
    void event_close_failed (const endpoint_uri_pair_t &endpoint_uri_pair_,
                             int err_);
    void event_disconnected (const endpoint_uri_pair_t &endpoint_uri_pair_,
                             zmq::fd_t fd_);
    void event_handshake_failed_no_detail (
      const endpoint_uri_pair_t &endpoint_uri_pair_, int err_);
    void event_handshake_failed_protocol (
      const endpoint_uri_pair_t &endpoint_uri_pair_, int err_);
    void
    event_handshake_failed_auth (const endpoint_uri_pair_t &endpoint_uri_pair_,
                                 int err_);
    void
    event_handshake_succeeded (const endpoint_uri_pair_t &endpoint_uri_pair_,
                               int err_);
154 155 156

    //  Query the state of a specific peer. The default implementation
    //  always returns an ENOTSUP error.
157 158
    virtual int get_peer_state (const void *routing_id_,
                                size_t routing_id_size_) const;
159 160 161 162 163 164 165 166 167 168 169

  protected:
    socket_base_t (zmq::ctx_t *parent_,
                   uint32_t tid_,
                   int sid_,
                   bool thread_safe_ = false);
    virtual ~socket_base_t ();

    //  Concrete algorithms for the x- methods are to be defined by
    //  individual socket types.
    virtual void xattach_pipe (zmq::pipe_t *pipe_,
170 171
                               bool subscribe_to_all_ = false,
                               bool locally_initiated_ = false) = 0;
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

    //  The default implementation assumes there are no specific socket
    //  options for the particular socket type. If not so, override this
    //  method.
    virtual int
    xsetsockopt (int option_, const void *optval_, size_t optvallen_);

    //  The default implementation assumes that send is not supported.
    virtual bool xhas_out ();
    virtual int xsend (zmq::msg_t *msg_);

    //  The default implementation assumes that recv in not supported.
    virtual bool xhas_in ();
    virtual int xrecv (zmq::msg_t *msg_);

    //  i_pipe_events will be forwarded to these functions.
    virtual void xread_activated (pipe_t *pipe_);
    virtual void xwrite_activated (pipe_t *pipe_);
    virtual void xhiccuped (pipe_t *pipe_);
    virtual void xpipe_terminated (pipe_t *pipe_) = 0;

    //  the default implementation assumes that joub and leave are not supported.
    virtual int xjoin (const char *group_);
    virtual int xleave (const char *group_);

    //  Delay actual destruction of the socket.
    void process_destroy ();

  private:
    // test if event should be sent and then dispatch it
202 203 204
    void event (const endpoint_uri_pair_t &endpoint_uri_pair_,
                uint64_t value_,
                uint64_t type_);
205 206

    // Socket event data dispatch
207 208 209
    void monitor_event (uint64_t event_,
                        uint64_t value_,
                        const endpoint_uri_pair_t &endpoint_uri_pair_) const;
210 211 212 213 214

    // Monitor socket cleanup
    void stop_monitor (bool send_monitor_stopped_event_ = true);

    //  Creates new endpoint ID and adds the endpoint to the map.
215 216 217
    void add_endpoint (const endpoint_uri_pair_t &endpoint_pair_,
                       own_t *endpoint_,
                       pipe_t *pipe_);
218 219 220 221

    //  Map of open endpoints.
    typedef std::pair<own_t *, pipe_t *> endpoint_pipe_t;
    typedef std::multimap<std::string, endpoint_pipe_t> endpoints_t;
222
    endpoints_t _endpoints;
223 224

    //  Map of open inproc endpoints.
225 226 227
    class inprocs_t
    {
      public:
228 229
        void emplace (const char *endpoint_uri_, pipe_t *pipe_);
        int erase_pipes (const std::string &endpoint_uri_str_);
230 231 232 233 234 235
        void erase_pipe (pipe_t *pipe_);

      private:
        typedef std::multimap<std::string, pipe_t *> map_t;
        map_t _inprocs;
    };
236
    inprocs_t _inprocs;
237 238 239 240 241 242 243 244 245 246

    //  To be called after processing commands or invoking any command
    //  handlers explicitly. If required, it will deallocate the socket.
    void check_destroy ();

    //  Moves the flags from the message to local variables,
    //  to be later retrieved by getsockopt.
    void extract_flags (msg_t *msg_);

    //  Used to check whether the object is a socket.
247
    uint32_t _tag;
248 249

    //  If true, associated context was already terminated.
250
    bool _ctx_terminated;
251 252 253 254

    //  If true, object should have been already destroyed. However,
    //  destruction is delayed while we unwind the stack to the point
    //  where it doesn't intersect the object being destroyed.
255
    bool _destroyed;
256

257
    //  Parse URI string.
258
    static int
259
    parse_uri (const char *uri_, std::string &protocol_, std::string &path_);
260

261 262
    //  Check whether transport protocol, as specified in connect or
    //  bind, is available and compatible with the socket type.
263
    int check_protocol (const std::string &protocol_) const;
264

265
    //  Register the pipe with this socket.
266 267 268
    void attach_pipe (zmq::pipe_t *pipe_,
                      bool subscribe_to_all_ = false,
                      bool locally_initiated_ = false);
269

270 271 272 273 274
    //  Processes commands sent to this socket (if any). If timeout is -1,
    //  returns only after at least one command was processed.
    //  If throttle argument is true, commands are processed at most once
    //  in a predefined time period.
    int process_commands (int timeout_, bool throttle_);
275

276 277 278 279 280
    //  Handlers for incoming commands.
    void process_stop ();
    void process_bind (zmq::pipe_t *pipe_);
    void process_term (int linger_);
    void process_term_endpoint (std::string *endpoint_);
281

282
    void update_pipe_options (int option_);
283

284
    std::string resolve_tcp_addr (std::string endpoint_uri_,
285 286
                                  const char *tcp_address_);

287
    //  Socket's mailbox object.
288
    i_mailbox *_mailbox;
289

290 291
    //  List of attached pipes.
    typedef array_t<pipe_t, 3> pipes_t;
292
    pipes_t _pipes;
293

294
    //  Reaper's poller and handle of this socket within it.
295 296
    poller_t *_poller;
    poller_t::handle_t _handle;
297

298
    //  Timestamp of when commands were processed the last time.
299
    uint64_t _last_tsc;
Martin Sustrik's avatar
Martin Sustrik committed
300

301
    //  Number of messages received since last command processing.
302
    int _ticks;
303

304
    //  True if the last message received had MORE flag set.
305
    bool _rcvmore;
306

307
    //  Improves efficiency of time measurement.
308
    clock_t _clock;
309

310
    // Monitor socket;
311
    void *_monitor_socket;
312

313
    // Bitmask of events being monitored
314
    int64_t _monitor_events;
315

316
    // Last socket endpoint resolved URI
317
    std::string _last_endpoint;
somdoron's avatar
somdoron committed
318

319
    // Indicate if the socket is thread safe
320
    const bool _thread_safe;
somdoron's avatar
somdoron committed
321

322
    // Signaler to be used in the reaping stage
323
    signaler_t *_reaper_signaler;
somdoron's avatar
somdoron committed
324

325
    // Mutex for synchronize access to the socket in thread safe mode
326
    mutex_t _sync;
327

328
    // Mutex to synchronize access to the monitor Pair socket
329
    mutex_t _monitor_sync;
330

331 332 333
    socket_base_t (const socket_base_t &);
    const socket_base_t &operator= (const socket_base_t &);
};
334 335 336 337 338

class routing_socket_base_t : public socket_base_t
{
  protected:
    routing_socket_base_t (class ctx_t *parent_, uint32_t tid_, int sid_);
339
    ~routing_socket_base_t ();
340

341
    // methods from socket_base_t
342 343
    virtual int
    xsetsockopt (int option_, const void *optval_, size_t optvallen_);
344
    virtual void xwrite_activated (pipe_t *pipe_);
345

346
    // own methods
347
    std::string extract_connect_routing_id ();
348
    bool connect_routing_id_is_set () const;
349

350 351
    struct out_pipe_t
    {
352
        pipe_t *pipe;
353 354 355
        bool active;
    };

356 357 358 359
    void add_out_pipe (blob_t routing_id_, pipe_t *pipe_);
    bool has_out_pipe (const blob_t &routing_id_) const;
    out_pipe_t *lookup_out_pipe (const blob_t &routing_id_);
    const out_pipe_t *lookup_out_pipe (const blob_t &routing_id_) const;
360
    void erase_out_pipe (pipe_t *pipe_);
361 362
    out_pipe_t try_erase_out_pipe (const blob_t &routing_id_);
    template <typename Func> bool any_of_out_pipes (Func func_)
363 364 365
    {
        bool res = false;
        for (out_pipes_t::iterator it = _out_pipes.begin ();
366
             it != _out_pipes.end () && !res; ++it) {
367
            res |= func_ (*it->second.pipe);
368 369 370 371 372 373
        }

        return res;
    }

  private:
374 375 376 377
    //  Outbound pipes indexed by the peer IDs.
    typedef std::map<blob_t, out_pipe_t> out_pipes_t;
    out_pipes_t _out_pipes;

378 379 380
    // Next assigned name on a zmq_connect() call used by ROUTER and STREAM socket types
    std::string _connect_routing_id;
};
381 382 383
}

#endif