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 libzmq is free software; you can redistribute it and/or modify it under
7 the terms of the GNU Lesser General Public License (LGPL) as published
8 by the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 As a special exception, the Contributors give you permission to link
12 this library with independent modules to produce an executable,
13 regardless of the license terms of these independent modules, and to
14 copy and distribute the resulting executable under terms of your choice,
15 provided that you also meet, for each linked independent module, the
16 terms and conditions of the license of that module. An independent
17 module is a module which is not derived from or based on this library.
18 If you modify this library, you must extend this exception to your
19 version of the library.
20
21 libzmq is distributed in the hope that it will be useful, but WITHOUT
22 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
24 License for more details.
25
26 You should have received a copy of the GNU Lesser General Public License
27 along with this program. If not, see <http://www.gnu.org/licenses/>.
28*/
29
30#ifndef __ZMQ_ROUTER_HPP_INCLUDED__
31#define __ZMQ_ROUTER_HPP_INCLUDED__
32
33#include <map>
34
35#include "socket_base.hpp"
36#include "session_base.hpp"
37#include "stdint.hpp"
38#include "blob.hpp"
39#include "msg.hpp"
40#include "fq.hpp"
41
42namespace zmq
43{
44class ctx_t;
45class pipe_t;
46
47// TODO: This class uses O(n) scheduling. Rewrite it to use O(1) algorithm.
48class router_t : public routing_socket_base_t
49{
50 public:
51 router_t (zmq::ctx_t *parent_, uint32_t tid_, int sid_);
52 ~router_t ();
53
54 // Overrides of functions from socket_base_t.
55 void xattach_pipe (zmq::pipe_t *pipe_,
56 bool subscribe_to_all_,
57 bool locally_initiated_);
58 int xsetsockopt (int option_, const void *optval_, size_t optvallen_);
59 int xsend (zmq::msg_t *msg_);
60 int xrecv (zmq::msg_t *msg_);
61 bool xhas_in ();
62 bool xhas_out ();
63 void xread_activated (zmq::pipe_t *pipe_);
64 void xpipe_terminated (zmq::pipe_t *pipe_);
65 int get_peer_state (const void *routing_id_, size_t routing_id_size_) const;
66
67 protected:
68 // Rollback any message parts that were sent but not yet flushed.
69 int rollback ();
70
71 private:
72 // Receive peer id and update lookup map
73 bool identify_peer (pipe_t *pipe_, bool locally_initiated_);
74
75 // Fair queueing object for inbound pipes.
76 fq_t _fq;
77
78 // True iff there is a message held in the pre-fetch buffer.
79 bool _prefetched;
80
81 // If true, the receiver got the message part with
82 // the peer's identity.
83 bool _routing_id_sent;
84
85 // Holds the prefetched identity.
86 msg_t _prefetched_id;
87
88 // Holds the prefetched message.
89 msg_t _prefetched_msg;
90
91 // The pipe we are currently reading from
92 zmq::pipe_t *_current_in;
93
94 // Should current_in should be terminate after all parts received?
95 bool _terminate_current_in;
96
97 // If true, more incoming message parts are expected.
98 bool _more_in;
99
100 // We keep a set of pipes that have not been identified yet.
101 std::set<pipe_t *> _anonymous_pipes;
102
103 // The pipe we are currently writing to.
104 zmq::pipe_t *_current_out;
105
106 // If true, more outgoing message parts are expected.
107 bool _more_out;
108
109 // Routing IDs are generated. It's a simple increment and wrap-over
110 // algorithm. This value is the next ID to use (if not used already).
111 uint32_t _next_integral_routing_id;
112
113 // If true, report EAGAIN to the caller instead of silently dropping
114 // the message targeting an unknown peer.
115 bool _mandatory;
116 bool _raw_socket;
117
118 // if true, send an empty message to every connected router peer
119 bool _probe_router;
120
121 // If true, the router will reassign an identity upon encountering a
122 // name collision. The new pipe will take the identity, the old pipe
123 // will be terminated.
124 bool _handover;
125
126 ZMQ_NON_COPYABLE_NOR_MOVABLE (router_t)
127};
128}
129
130#endif
131