router.hpp 4.6 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
    You should have received a copy of the GNU Lesser General Public License
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30 31
#ifndef __ZMQ_ROUTER_HPP_INCLUDED__
#define __ZMQ_ROUTER_HPP_INCLUDED__
32

33 34
#include <map>

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 42 43 44

namespace zmq
{

45 46 47
    class ctx_t;
    class pipe_t;

48
    //  TODO: This class uses O(n) scheduling. Rewrite it to use O(1) algorithm.
49
    class router_t :
50
        public socket_base_t
51 52 53
    {
    public:

54 55
        router_t (zmq::ctx_t *parent_, uint32_t tid_, int sid);
        ~router_t ();
56

57
        //  Overrides of functions from socket_base_t.
58
        void xattach_pipe (zmq::pipe_t *pipe_, bool subscribe_to_all_);
59
        int xsetsockopt (int option_, const void *optval_, size_t optvallen_);
60 61
        int xsend (zmq::msg_t *msg_);
        int xrecv (zmq::msg_t *msg_);
62 63
        bool xhas_in ();
        bool xhas_out ();
64 65
        void xread_activated (zmq::pipe_t *pipe_);
        void xwrite_activated (zmq::pipe_t *pipe_);
66
        void xpipe_terminated (zmq::pipe_t *pipe_);
Stoian Ivanov's avatar
Stoian Ivanov committed
67

68 69 70 71
    protected:

        //  Rollback any message parts that were sent but not yet flushed.
        int rollback ();
72
        blob_t get_credential () const;
73

74 75
    private:

76 77 78
        //  Receive peer id and update lookup map
        bool identify_peer (pipe_t *pipe_);

79 80
        //  Fair queueing object for inbound pipes.
        fq_t fq;
81

82 83 84 85 86 87
        //  True iff there is a message held in the pre-fetch buffer.
        bool prefetched;

        //  If true, the receiver got the message part with
        //  the peer's identity.
        bool identity_sent;
88 89

        //  Holds the prefetched identity.
90
        msg_t prefetched_id;
91 92

        //  Holds the prefetched message.
93
        msg_t prefetched_msg;
94

95 96 97 98 99 100
        //  The pipe we are currently reading from
        zmq::pipe_t *current_in;

        //  Should current_in should be terminate after all parts received?
        bool terminate_current_in;

101 102 103 104 105
        //  If true, more incoming message parts are expected.
        bool more_in;

        struct outpipe_t
        {
106
            zmq::pipe_t *pipe;
107 108
            bool active;
        };
109

110 111 112
        //  We keep a set of pipes that have not been identified yet.
        std::set <pipe_t*> anonymous_pipes;

113
        //  Outbound pipes indexed by the peer IDs.
114
        typedef std::map <blob_t, outpipe_t> outpipes_t;
115 116
        outpipes_t outpipes;

117
        //  The pipe we are currently writing to.
118
        zmq::pipe_t *current_out;
119 120 121 122

        //  If true, more outgoing message parts are expected.
        bool more_out;

123
        //  Routing IDs are generated. It's a simple increment and wrap-over
124
        //  algorithm. This value is the next ID to use (if not used already).
125
        uint32_t next_rid;
126

127 128
        // If true, report EAGAIN to the caller instead of silently dropping 
        // the message targeting an unknown peer.
129
        bool mandatory;
130
        bool raw_socket;
131

132 133
        // if true, send an empty message to every connected router peer
        bool probe_router;
134

135 136 137
        // If true, the router will reassign an identity upon encountering a
        // name collision. The new pipe will take the identity, the old pipe
        // will be terminated.
138
        bool handover;
139

140 141
        router_t (const router_t&);
        const router_t &operator = (const router_t&);
142 143 144 145 146
    };

}

#endif