xsub.cpp 7.16 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 27 28 29 30 31

    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 <string.h>

32
#include "macros.hpp"
33 34 35
#include "xsub.hpp"
#include "err.hpp"

36 37
zmq::xsub_t::xsub_t (class ctx_t *parent_, uint32_t tid_, int sid_) :
    socket_base_t (parent_, tid_, sid_),
38 39
    has_message (false),
    more (false)
40
{
41
    options.type = ZMQ_XSUB;
42 43 44 45 46

    //  When socket is being closed down we don't want to wait till pending
    //  subscription commands are sent to the wire.
    options.linger = 0;

47 48
    int rc = message.init ();
    errno_assert (rc == 0);
49 50 51 52
}

zmq::xsub_t::~xsub_t ()
{
53 54
    int rc = message.close ();
    errno_assert (rc == 0);
55 56
}

57
void zmq::xsub_t::xattach_pipe (pipe_t *pipe_, bool subscribe_to_all_)
58
{
59
    LIBZMQ_UNUSED (subscribe_to_all_);
60

61 62
    zmq_assert (pipe_);
    fq.attach (pipe_);
63 64 65 66 67
    dist.attach (pipe_);

    //  Send all the cached subscriptions to the new upstream peer.
    subscriptions.apply (send_subscription, pipe_);
    pipe_->flush ();
68 69
}

70
void zmq::xsub_t::xread_activated (pipe_t *pipe_)
71 72 73 74
{
    fq.activated (pipe_);
}

75 76 77 78 79
void zmq::xsub_t::xwrite_activated (pipe_t *pipe_)
{
    dist.activated (pipe_);
}

80
void zmq::xsub_t::xpipe_terminated (pipe_t *pipe_)
81
{
82 83
    fq.pipe_terminated (pipe_);
    dist.pipe_terminated (pipe_);
84 85
}

86
void zmq::xsub_t::xhiccuped (pipe_t *pipe_)
87
{
88 89 90 91 92
    //  Send all the cached subscriptions to the hiccuped pipe.
    subscriptions.apply (send_subscription, pipe_);
    pipe_->flush ();
}

93
int zmq::xsub_t::xsend (msg_t *msg_)
94 95
{
    size_t size = msg_->size ();
96
    unsigned char *data = (unsigned char *) msg_->data ();
97

98
    if (size > 0 && *data == 1) {
99
        //  Process subscribe message
100 101 102 103
        //  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.
Pieter Hintjens's avatar
Pieter Hintjens committed
104
        subscriptions.add (data + 1, size - 1);
105
        return dist.send_to_all (msg_);
106
    }
107
    else 
108
    if (size > 0 && *data == 0) {
109
        //  Process unsubscribe message
110
        if (subscriptions.rm (data + 1, size - 1))
111
            return dist.send_to_all (msg_);
112
    }
113 114
    else 
        //  User message sent upstream to XPUB socket
115
        return dist.send_to_all (msg_);
116

Martin Hurton's avatar
Martin Hurton committed
117 118 119 120 121 122
    int rc = msg_->close ();
    errno_assert (rc == 0);
    rc = msg_->init ();
    errno_assert (rc == 0);

    return 0;
123 124 125 126 127 128
}

bool zmq::xsub_t::xhas_out ()
{
    //  Subscription can be added/removed anytime.
    return true;
129 130
}

131
int zmq::xsub_t::xrecv (msg_t *msg_)
132
{
133 134 135 136 137 138
    //  If there's already a message prepared by a previous call to zmq_poll,
    //  return it straight ahead.
    if (has_message) {
        int rc = msg_->move (message);
        errno_assert (rc == 0);
        has_message = false;
139
        more = msg_->flags () & msg_t::more ? true : false;
140 141 142 143 144 145 146 147 148
        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.
149
        int rc = fq.recv (msg_);
150 151 152 153 154 155 156 157

        //  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 
158
        if (more || !options.filter || match (msg_)) {
159
            more = msg_->flags () & msg_t::more ? true : false;
160 161 162 163 164
            return 0;
        }

        //  Message doesn't match. Pop any remaining parts of the message
        //  from the pipe.
165
        while (msg_->flags () & msg_t::more) {
166
            rc = fq.recv (msg_);
167
            errno_assert (rc == 0);
168 169
        }
    }
170 171 172 173
}

bool zmq::xsub_t::xhas_in ()
{
174 175 176 177 178 179 180 181 182 183 184 185 186 187
    //  There are subsequent parts of the partly-read message available.
    if (more)
        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.
188
        int rc = fq.recv (&message);
189 190 191 192

        //  If there's no message available, return immediately.
        //  The same when error occurs.
        if (rc != 0) {
193
            errno_assert (errno == EAGAIN);
194 195 196 197
            return false;
        }

        //  Check whether the message matches at least one subscription.
198
        if (!options.filter || match (&message)) {
199 200 201 202 203 204
            has_message = true;
            return true;
        }

        //  Message doesn't match. Pop any remaining parts of the message
        //  from the pipe.
205
        while (message.flags () & msg_t::more) {
206
            rc = fq.recv (&message);
207
            errno_assert (rc == 0);
208 209 210 211
        }
    }
}

212 213 214 215 216
zmq::blob_t zmq::xsub_t::get_credential () const
{
    return fq.get_credential ();
}

217 218
bool zmq::xsub_t::match (msg_t *msg_)
{
219 220 221
    bool matching = subscriptions.check ((unsigned char*) msg_->data (), msg_->size ());

    return matching ^ options.invert_matching;
222
}
223

224 225 226 227 228 229 230 231
void zmq::xsub_t::send_subscription (unsigned char *data_, size_t size_,
    void *arg_)
{
    pipe_t *pipe = (pipe_t*) arg_;

    //  Create the subsctription message.
    msg_t msg;
    int rc = msg.init_size (size_ + 1);
232
    errno_assert (rc == 0);
233 234
    unsigned char *data = (unsigned char*) msg.data ();
    data [0] = 1;
235 236
    if (size_ > 0)
        memcpy (data + 1, data_, size_);
237 238 239

    //  Send it to the pipe.
    bool sent = pipe->write (&msg);
240 241 242 243 244 245
    //  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 ();
246
}