1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/*
Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
This file is part of libzmq, the ZeroMQ core engine in C++.
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
(at your option) any later version.
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.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "precompiled.hpp"
#include <string.h>
#include "macros.hpp"
#include "xsub.hpp"
#include "err.hpp"
zmq::xsub_t::xsub_t (class ctx_t *parent_, uint32_t tid_, int sid_) :
socket_base_t (parent_, tid_, sid_),
_has_message (false),
_more_send (false),
_more_recv (false),
_process_subscribe (false),
_only_first_subscribe (false)
{
options.type = ZMQ_XSUB;
// When socket is being closed down we don't want to wait till pending
// subscription commands are sent to the wire.
options.linger.store (0);
const int rc = _message.init ();
errno_assert (rc == 0);
}
zmq::xsub_t::~xsub_t ()
{
const int rc = _message.close ();
errno_assert (rc == 0);
}
void zmq::xsub_t::xattach_pipe (pipe_t *pipe_,
bool subscribe_to_all_,
bool locally_initiated_)
{
LIBZMQ_UNUSED (subscribe_to_all_);
LIBZMQ_UNUSED (locally_initiated_);
zmq_assert (pipe_);
_fq.attach (pipe_);
_dist.attach (pipe_);
// Send all the cached subscriptions to the new upstream peer.
_subscriptions.apply (send_subscription, pipe_);
pipe_->flush ();
}
void zmq::xsub_t::xread_activated (pipe_t *pipe_)
{
_fq.activated (pipe_);
}
void zmq::xsub_t::xwrite_activated (pipe_t *pipe_)
{
_dist.activated (pipe_);
}
void zmq::xsub_t::xpipe_terminated (pipe_t *pipe_)
{
_fq.pipe_terminated (pipe_);
_dist.pipe_terminated (pipe_);
}
void zmq::xsub_t::xhiccuped (pipe_t *pipe_)
{
// Send all the cached subscriptions to the hiccuped pipe.
_subscriptions.apply (send_subscription, pipe_);
pipe_->flush ();
}
int zmq::xsub_t::xsetsockopt (int option_,
const void *optval_,
size_t optvallen_)
{
if (option_ == ZMQ_ONLY_FIRST_SUBSCRIBE) {
if (optvallen_ != sizeof (int)
|| *static_cast<const int *> (optval_) < 0) {
errno = EINVAL;
return -1;
}
_only_first_subscribe = (*static_cast<const int *> (optval_) != 0);
return 0;
}
errno = EINVAL;
return -1;
}
int zmq::xsub_t::xsend (msg_t *msg_)
{
size_t size = msg_->size ();
unsigned char *data = static_cast<unsigned char *> (msg_->data ());
const bool first_part = !_more_send;
_more_send = (msg_->flags () & msg_t::more) != 0;
if (first_part) {
_process_subscribe = !_only_first_subscribe;
} else if (!_process_subscribe) {
// User message sent upstream to XPUB socket
return _dist.send_to_all (msg_);
}
if (msg_->is_subscribe () || (size > 0 && *data == 1)) {
// Process subscribe message
// This used to filter out duplicate subscriptions,
// however this is alread done on the XPUB side and
// doing it here as well breaks ZMQ_XPUB_VERBOSE
// when there are forwarding devices involved.
if (!msg_->is_subscribe ()) {
data = data + 1;
size = size - 1;
}
_subscriptions.add (data, size);
_process_subscribe = true;
return _dist.send_to_all (msg_);
}
if (msg_->is_cancel () || (size > 0 && *data == 0)) {
// Process unsubscribe message
if (!msg_->is_cancel ()) {
data = data + 1;
size = size - 1;
}
_process_subscribe = true;
if (_subscriptions.rm (data, size))
return _dist.send_to_all (msg_);
} else
// User message sent upstream to XPUB socket
return _dist.send_to_all (msg_);
int rc = msg_->close ();
errno_assert (rc == 0);
rc = msg_->init ();
errno_assert (rc == 0);
return 0;
}
bool zmq::xsub_t::xhas_out ()
{
// Subscription can be added/removed anytime.
return true;
}
int zmq::xsub_t::xrecv (msg_t *msg_)
{
// If there's already a message prepared by a previous call to zmq_poll,
// return it straight ahead.
if (_has_message) {
const int rc = msg_->move (_message);
errno_assert (rc == 0);
_has_message = false;
_more_recv = (msg_->flags () & msg_t::more) != 0;
return 0;
}
// TODO: This can result in infinite loop in the case of continuous
// stream of non-matching messages which breaks the non-blocking recv
// semantics.
while (true) {
// Get a message using fair queueing algorithm.
int rc = _fq.recv (msg_);
// If there's no message available, return immediately.
// The same when error occurs.
if (rc != 0)
return -1;
// Check whether the message matches at least one subscription.
// Non-initial parts of the message are passed
if (_more_recv || !options.filter || match (msg_)) {
_more_recv = (msg_->flags () & msg_t::more) != 0;
return 0;
}
// Message doesn't match. Pop any remaining parts of the message
// from the pipe.
while (msg_->flags () & msg_t::more) {
rc = _fq.recv (msg_);
errno_assert (rc == 0);
}
}
}
bool zmq::xsub_t::xhas_in ()
{
// There are subsequent parts of the partly-read message available.
if (_more_recv)
return true;
// If there's already a message prepared by a previous call to zmq_poll,
// return straight ahead.
if (_has_message)
return true;
// TODO: This can result in infinite loop in the case of continuous
// stream of non-matching messages.
while (true) {
// Get a message using fair queueing algorithm.
int rc = _fq.recv (&_message);
// If there's no message available, return immediately.
// The same when error occurs.
if (rc != 0) {
errno_assert (errno == EAGAIN);
return false;
}
// Check whether the message matches at least one subscription.
if (!options.filter || match (&_message)) {
_has_message = true;
return true;
}
// Message doesn't match. Pop any remaining parts of the message
// from the pipe.
while (_message.flags () & msg_t::more) {
rc = _fq.recv (&_message);
errno_assert (rc == 0);
}
}
}
bool zmq::xsub_t::match (msg_t *msg_)
{
const bool matching = _subscriptions.check (
static_cast<unsigned char *> (msg_->data ()), msg_->size ());
return matching ^ options.invert_matching;
}
void zmq::xsub_t::send_subscription (unsigned char *data_,
size_t size_,
void *arg_)
{
pipe_t *pipe = static_cast<pipe_t *> (arg_);
// Create the subscription message.
msg_t msg;
const int rc = msg.init_subscribe (size_, data_);
errno_assert (rc == 0);
// Send it to the pipe.
const bool sent = pipe->write (&msg);
// If we reached the SNDHWM, and thus cannot send the subscription, drop
// the subscription message instead. This matches the behaviour of
// zmq_setsockopt(ZMQ_SUBSCRIBE, ...), which also drops subscriptions
// when the SNDHWM is reached.
if (!sent)
msg.close ();
}