dist.hpp 3.16 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2013 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_DIST_HPP_INCLUDED__
#define __ZMQ_DIST_HPP_INCLUDED__

23 24
#include <vector>

25 26 27 28 29 30
#include "array.hpp"
#include "pipe.hpp"

namespace zmq
{

31 32 33
    class pipe_t;
    class msg_t;

34 35
    //  Class manages a set of outbound pipes. It sends each messages to
    //  each of them.
36
    class dist_t
37 38 39
    {
    public:

40
        dist_t ();
41 42
        ~dist_t ();

43
        //  Adds the pipe to the distributor object.
44
        void attach (zmq::pipe_t *pipe_);
45 46

        //  Activates pipe that have previously reached high watermark.
47
        void activated (zmq::pipe_t *pipe_);
48 49 50

        //  Mark the pipe as matching. Subsequent call to send_to_matching
        //  will send message also to this pipe.
51
        void match (zmq::pipe_t *pipe_);
52

53 54 55
        //  Mark all pipes as non-matching.
        void unmatch ();

56
        //  Removes the pipe from the distributor object.
57
        void terminated (zmq::pipe_t *pipe_);
58

59
        //  Send the message to the matching outbound pipes.
60
        int send_to_matching (zmq::msg_t *msg_);
61

62
        //  Send the message to all the outbound pipes.
63
        int send_to_all (zmq::msg_t *msg_);
64

65 66
        bool has_out ();

67 68 69 70
    private:

        //  Write the message to the pipe. Make the pipe inactive if writing
        //  fails. In such a case false is returned.
71
        bool write (zmq::pipe_t *pipe_, zmq::msg_t *msg_);
72

73
        //  Put the message to all active pipes.
74
        void distribute (zmq::msg_t *msg_);
75

76
        //  List of outbound pipes.
77
        typedef array_t <zmq::pipe_t, 2> pipes_t;
78 79
        pipes_t pipes;

80 81 82
        //  Number of all the pipes to send the next message to.
        pipes_t::size_type matching;

83
        //  Number of active pipes. All the active pipes are located at the
84 85
        //  beginning of the pipes array. These are the pipes the messages
        //  can be sent to at the moment.
86 87
        pipes_t::size_type active;

88 89 90 91 92 93 94
        //  Number of pipes eligible for sending messages to. This includes all
        //  the active pipes plus all the pipes that we can in theory send
        //  messages to (the HWM is not yet reached), but sending a message
        //  to them would result in partial message being delivered, ie. message
        //  with initial parts missing.
        pipes_t::size_type eligible;

95 96 97 98 99 100 101 102 103 104
        //  True if last we are in the middle of a multipart message.
        bool more;

        dist_t (const dist_t&);
        const dist_t &operator = (const dist_t&);
    };

}

#endif