mailbox_safe.hpp 2.96 KB
Newer Older
somdoron's avatar
somdoron committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
somdoron's avatar
somdoron committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
somdoron's avatar
somdoron committed
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
somdoron's avatar
somdoron committed
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.
somdoron's avatar
somdoron committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

    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_MAILBOX_SAFE_HPP_INCLUDED__
#define __ZMQ_MAILBOX_SAFE_HPP_INCLUDED__

#include <vector>
#include <stddef.h>

#include "signaler.hpp"
#include "fd.hpp"
#include "config.hpp"
#include "command.hpp"
#include "ypipe.hpp"
#include "mutex.hpp"
#include "i_mailbox.hpp"
#include "condition_variable.hpp"

namespace zmq
{
47 48 49 50 51
class mailbox_safe_t : public i_mailbox
{
  public:
    mailbox_safe_t (mutex_t *sync_);
    ~mailbox_safe_t ();
somdoron's avatar
somdoron committed
52

53 54
    void send (const command_t &cmd_);
    int recv (command_t *cmd_, int timeout_);
somdoron's avatar
somdoron committed
55

56 57 58 59
    // Add signaler to mailbox which will be called when a message is ready
    void add_signaler (signaler_t *signaler);
    void remove_signaler (signaler_t *signaler);
    void clear_signalers ();
somdoron's avatar
somdoron committed
60 61

#ifdef HAVE_FORK
62 63 64 65 66 67 68
    // close the file descriptors in the signaller. This is used in a forked
    // child process to close the file descriptors so that they do not interfere
    // with the context in the parent process.
    void forked ()
    {
        // TODO: call fork on the condition variable
    }
somdoron's avatar
somdoron committed
69 70
#endif

71 72 73 74
  private:
    //  The pipe to store actual commands.
    typedef ypipe_t<command_t, command_pipe_granularity> cpipe_t;
    cpipe_t cpipe;
somdoron's avatar
somdoron committed
75

76 77
    //  Condition variable to pass signals from writer thread to reader thread.
    condition_variable_t cond_var;
somdoron's avatar
somdoron committed
78

79
    //  Synchronize access to the mailbox from receivers and senders
80
    mutex_t *const sync;
somdoron's avatar
somdoron committed
81

82
    std::vector<zmq::signaler_t *> signalers;
somdoron's avatar
somdoron committed
83

84 85 86 87
    //  Disable copying of mailbox_t object.
    mailbox_safe_t (const mailbox_safe_t &);
    const mailbox_safe_t &operator= (const mailbox_safe_t &);
};
somdoron's avatar
somdoron committed
88 89 90
}

#endif