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

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik 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
Martin Sustrik's avatar
Martin Sustrik 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.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30 31
#ifndef __ZMQ_MAILBOX_HPP_INCLUDED__
#define __ZMQ_MAILBOX_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

33 34
#include <stddef.h>

35
#include "signaler.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
36
#include "fd.hpp"
37
#include "config.hpp"
38
#include "command.hpp"
39 40
#include "ypipe.hpp"
#include "mutex.hpp"
somdoron's avatar
somdoron committed
41
#include "i_mailbox.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
42

Martin Sustrik's avatar
Martin Sustrik committed
43
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
44
{
45 46 47 48 49
class mailbox_t : public i_mailbox
{
  public:
    mailbox_t ();
    ~mailbox_t ();
Martin Sustrik's avatar
Martin Sustrik committed
50

51 52 53
    fd_t get_fd () const;
    void send (const command_t &cmd_);
    int recv (command_t *cmd_, int timeout_);
Martin Hurton's avatar
Martin Hurton committed
54

55
    bool valid () const;
56

57
#ifdef HAVE_FORK
58 59 60
    // 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.
61
    void forked () { _signaler.forked (); }
62 63
#endif

64 65 66
  private:
    //  The pipe to store actual commands.
    typedef ypipe_t<command_t, command_pipe_granularity> cpipe_t;
67
    cpipe_t _cpipe;
68

69
    //  Signaler to pass signals from writer thread to reader thread.
70
    signaler_t _signaler;
71

72 73 74 75
    //  There's only one thread receiving from the mailbox, but there
    //  is arbitrary number of threads sending. Given that ypipe requires
    //  synchronised access on both of its endpoints, we have to synchronise
    //  the sending side.
76
    mutex_t _sync;
77

78 79
    //  True if the underlying pipe is active, ie. when we are allowed to
    //  read commands from it.
80
    bool _active;
Martin Sustrik's avatar
Martin Sustrik committed
81

82 83 84 85
    //  Disable copying of mailbox_t object.
    mailbox_t (const mailbox_t &);
    const mailbox_t &operator= (const mailbox_t &);
};
Martin Sustrik's avatar
Martin Sustrik committed
86 87 88
}

#endif