xpub.hpp 2.91 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2014 Contributors as noted in the AUTHORS file
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    0MQ 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/>.
*/

#ifndef __ZMQ_XPUB_HPP_INCLUDED__
#define __ZMQ_XPUB_HPP_INCLUDED__

23
#include <deque>
Martin Sustrik's avatar
Martin Sustrik committed
24
#include <string>
25

26
#include "socket_base.hpp"
27
#include "session_base.hpp"
28
#include "mtrie.hpp"
29
#include "array.hpp"
30
#include "dist.hpp"
31 32 33 34

namespace zmq
{

35 36 37 38 39
    class ctx_t;
    class msg_t;
    class pipe_t;
    class io_thread_t;

40
    class xpub_t :
41
        public socket_base_t
42 43 44
    {
    public:

45
        xpub_t (zmq::ctx_t *parent_, uint32_t tid_, int sid_);
46 47 48
        ~xpub_t ();

        //  Implementations of virtual functions from socket_base_t.
49
        void xattach_pipe (zmq::pipe_t *pipe_, bool subscribe_to_all_ = false);
50
        int xsend (zmq::msg_t *msg_);
51
        bool xhas_out ();
52
        int xrecv (zmq::msg_t *msg_);
53
        bool xhas_in ();
54 55
        void xread_activated (zmq::pipe_t *pipe_);
        void xwrite_activated (zmq::pipe_t *pipe_);
Pieter Hintjens's avatar
Pieter Hintjens committed
56
        int xsetsockopt (int option_, const void *optval_, size_t optvallen_);
57
        void xpipe_terminated (zmq::pipe_t *pipe_);
58 59 60

    private:

61 62 63 64 65
        //  Function to be applied to the trie to send all the subsciptions
        //  upstream.
        static void send_unsubscription (unsigned char *data_, size_t size_,
            void *arg_);

66
        //  Function to be applied to each matching pipes.
67
        static void mark_as_matching (zmq::pipe_t *pipe_, void *arg_);
68

69 70 71
        //  List of all subscriptions mapped to corresponding pipes.
        mtrie_t subscriptions;

72 73
        //  Distributor of messages holding the list of outbound pipes.
        dist_t dist;
74

Pieter Hintjens's avatar
Pieter Hintjens committed
75 76 77 78
        // If true, send all subscription messages upstream, not just
        // unique ones
        bool verbose;

79 80 81
        //  True if we are in the middle of sending a multi-part message.
        bool more;

82 83
        //  Drop messages if HWM reached, otherwise return with EAGAIN
        bool lossy;
84

85 86
        //  List of pending (un)subscriptions, ie. those that were already
        //  applied to the trie, but not yet received by the user.
Martin Sustrik's avatar
Martin Sustrik committed
87
        typedef std::basic_string <unsigned char> blob_t;
88 89
        std::deque <blob_t> pending_data;
        std::deque <unsigned char> pending_flags;
90

91
        xpub_t (const xpub_t&);
92
        const xpub_t &operator = (const xpub_t&);
93 94 95 96 97
    };

}

#endif