Line data Source code
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_MAILBOX_SAFE_HPP_INCLUDED__
31 : #define __ZMQ_MAILBOX_SAFE_HPP_INCLUDED__
32 :
33 : #include <vector>
34 : #include <stddef.h>
35 :
36 : #include "platform.hpp"
37 : #include "signaler.hpp"
38 : #include "fd.hpp"
39 : #include "config.hpp"
40 : #include "command.hpp"
41 : #include "ypipe.hpp"
42 : #include "mutex.hpp"
43 : #include "i_mailbox.hpp"
44 : #include "condition_variable.hpp"
45 :
46 : namespace zmq
47 : {
48 :
49 : class mailbox_safe_t : public i_mailbox
50 : {
51 : public:
52 :
53 : mailbox_safe_t (mutex_t* sync_);
54 : ~mailbox_safe_t ();
55 :
56 : void send (const command_t &cmd_);
57 : int recv (command_t *cmd_, int timeout_);
58 :
59 : // Add signaler to mailbox which will be called when a message is ready
60 : void add_signaler (signaler_t* signaler);
61 : void remove_signaler (signaler_t* signaler);
62 : void clear_signalers ();
63 :
64 : #ifdef HAVE_FORK
65 : // close the file descriptors in the signaller. This is used in a forked
66 : // child process to close the file descriptors so that they do not interfere
67 : // with the context in the parent process.
68 0 : void forked ()
69 : {
70 : // TODO: call fork on the condition variable
71 0 : }
72 : #endif
73 :
74 : private:
75 :
76 : // The pipe to store actual commands.
77 : typedef ypipe_t <command_t, command_pipe_granularity> cpipe_t;
78 : cpipe_t cpipe;
79 :
80 : // Condition variable to pass signals from writer thread to reader thread.
81 : condition_variable_t cond_var;
82 :
83 : // Synchronize access to the mailbox from receivers and senders
84 : mutex_t* sync;
85 :
86 : std::vector <zmq::signaler_t* > signalers;
87 :
88 : // Disable copying of mailbox_t object.
89 : mailbox_safe_t (const mailbox_safe_t&);
90 : const mailbox_safe_t &operator = (const mailbox_safe_t&);
91 : };
92 :
93 : }
94 :
95 : #endif
|