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     libzmq is free software; you can redistribute it and/or modify it under
7     the terms of the GNU Lesser General Public License (LGPL) as published
8     by the Free Software Foundation; either version 3 of the License, or
9     (at your option) any later version.
10 
11     As a special exception, the Contributors give you permission to link
12     this library with independent modules to produce an executable,
13     regardless of the license terms of these independent modules, and to
14     copy and distribute the resulting executable under terms of your choice,
15     provided that you also meet, for each linked independent module, the
16     terms and conditions of the license of that module. An independent
17     module is a module which is not derived from or based on this library.
18     If you modify this library, you must extend this exception to your
19     version of the library.
20 
21     libzmq is distributed in the hope that it will be useful, but WITHOUT
22     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23     FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
24     License for more details.
25 
26     You should have received a copy of the GNU Lesser General Public License
27     along with this program.  If not, see <http://www.gnu.org/licenses/>.
28 */
29 
30 #ifndef __ZMQ_DEALER_HPP_INCLUDED__
31 #define __ZMQ_DEALER_HPP_INCLUDED__
32 
33 #include "socket_base.hpp"
34 #include "session_base.hpp"
35 #include "fq.hpp"
36 #include "lb.hpp"
37 
38 namespace zmq
39 {
40 class ctx_t;
41 class msg_t;
42 class pipe_t;
43 class io_thread_t;
44 class socket_base_t;
45 
46 class dealer_t : public socket_base_t
47 {
48   public:
49     dealer_t (zmq::ctx_t *parent_, uint32_t tid_, int sid_);
50     ~dealer_t () ZMQ_OVERRIDE;
51 
52   protected:
53     //  Overrides of functions from socket_base_t.
54     void xattach_pipe (zmq::pipe_t *pipe_,
55                        bool subscribe_to_all_,
56                        bool locally_initiated_) ZMQ_FINAL;
57     int xsetsockopt (int option_,
58                      const void *optval_,
59                      size_t optvallen_) ZMQ_OVERRIDE;
60     int xsend (zmq::msg_t *msg_) ZMQ_OVERRIDE;
61     int xrecv (zmq::msg_t *msg_) ZMQ_OVERRIDE;
62     bool xhas_in () ZMQ_OVERRIDE;
63     bool xhas_out () ZMQ_OVERRIDE;
64     void xread_activated (zmq::pipe_t *pipe_) ZMQ_FINAL;
65     void xwrite_activated (zmq::pipe_t *pipe_) ZMQ_FINAL;
66     void xpipe_terminated (zmq::pipe_t *pipe_) ZMQ_OVERRIDE;
67 
68     //  Send and recv - knowing which pipe was used.
69     int sendpipe (zmq::msg_t *msg_, zmq::pipe_t **pipe_);
70     int recvpipe (zmq::msg_t *msg_, zmq::pipe_t **pipe_);
71 
72   private:
73     //  Messages are fair-queued from inbound pipes. And load-balanced to
74     //  the outbound pipes.
75     fq_t _fq;
76     lb_t _lb;
77 
78     // if true, send an empty message to every connected router peer
79     bool _probe_router;
80 
81     ZMQ_NON_COPYABLE_NOR_MOVABLE (dealer_t)
82 };
83 }
84 
85 #endif
86