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_STREAM_HPP_INCLUDED__
31#define __ZMQ_STREAM_HPP_INCLUDED__
32
33#include <map>
34
35#include "router.hpp"
36
37namespace zmq
38{
39class ctx_t;
40class pipe_t;
41
42class stream_t : public routing_socket_base_t
43{
44 public:
45 stream_t (zmq::ctx_t *parent_, uint32_t tid_, int sid_);
46 ~stream_t ();
47
48 // Overrides of functions from socket_base_t.
49 void xattach_pipe (zmq::pipe_t *pipe_,
50 bool subscribe_to_all_,
51 bool locally_initiated_);
52 int xsend (zmq::msg_t *msg_);
53 int xrecv (zmq::msg_t *msg_);
54 bool xhas_in ();
55 bool xhas_out ();
56 void xread_activated (zmq::pipe_t *pipe_);
57 void xpipe_terminated (zmq::pipe_t *pipe_);
58 int xsetsockopt (int option_, const void *optval_, size_t optvallen_);
59
60 private:
61 // Generate peer's id and update lookup map
62 void identify_peer (pipe_t *pipe_, bool locally_initiated_);
63
64 // Fair queueing object for inbound pipes.
65 fq_t _fq;
66
67 // True iff there is a message held in the pre-fetch buffer.
68 bool _prefetched;
69
70 // If true, the receiver got the message part with
71 // the peer's identity.
72 bool _routing_id_sent;
73
74 // Holds the prefetched identity.
75 msg_t _prefetched_routing_id;
76
77 // Holds the prefetched message.
78 msg_t _prefetched_msg;
79
80 // The pipe we are currently writing to.
81 zmq::pipe_t *_current_out;
82
83 // If true, more outgoing message parts are expected.
84 bool _more_out;
85
86 // Routing IDs are generated. It's a simple increment and wrap-over
87 // algorithm. This value is the next ID to use (if not used already).
88 uint32_t _next_integral_routing_id;
89
90 ZMQ_NON_COPYABLE_NOR_MOVABLE (stream_t)
91};
92}
93
94#endif
95