dbuffer.hpp 3.72 KB
Newer Older
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 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
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.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

    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_DBUFFER_HPP_INCLUDED__
#define __ZMQ_DBUFFER_HPP_INCLUDED__

#include <stdlib.h>
#include <stddef.h>
#include <algorithm>

#include "mutex.hpp"
#include "msg.hpp"

namespace zmq
{
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
//  dbuffer is a single-producer single-consumer double-buffer
//  implementation.
//
//  The producer writes to a back buffer and then tries to swap
//  pointers between the back and front buffers. If it fails,
//  due to the consumer reading from the front buffer, it just
//  gives up, which is ok since writes are many and redundant.
//
//  The reader simply reads from the front buffer.
//
//  has_msg keeps track of whether there has been a not yet read
//  value written, it is used by ypipe_conflate to mimic ypipe
//  functionality regarding a reader being asleep

template <typename T> class dbuffer_t;

template <> class dbuffer_t<msg_t>
{
  public:
    inline dbuffer_t () :
62 63 64
        _back (&_storage[0]),
        _front (&_storage[1]),
        _has_msg (false)
65
    {
66 67
        _back->init ();
        _front->init ();
68
    }
69

70 71
    inline ~dbuffer_t ()
    {
72 73
        _back->close ();
        _front->close ();
74
    }
75

76 77 78
    inline void write (const msg_t &value_)
    {
        msg_t &xvalue = const_cast<msg_t &> (value_);
79

80
        zmq_assert (xvalue.check ());
81
        _back->move (xvalue); // cannot just overwrite, might leak
82

83
        zmq_assert (_back->check ());
84

85 86 87
        if (_sync.try_lock ()) {
            std::swap (_back, _front);
            _has_msg = true;
88

89
            _sync.unlock ();
90
        }
91 92 93 94 95 96
    }

    inline bool read (msg_t *value_)
    {
        if (!value_)
            return false;
97 98

        {
99 100
            scoped_lock_t lock (_sync);
            if (!_has_msg)
101 102
                return false;

103
            zmq_assert (_front->check ());
104

105 106
            *value_ = *_front;
            _front->init (); // avoid double free
107

108
            _has_msg = false;
109
            return true;
110
        }
111
    }
112 113


114 115
    inline bool check_read ()
    {
116
        scoped_lock_t lock (_sync);
117

118
        return _has_msg;
119
    }
120

121
    inline bool probe (bool (*fn_) (const msg_t &))
122
    {
123 124
        scoped_lock_t lock (_sync);
        return (*fn_) (*_front);
125
    }
126 127


128
  private:
129 130
    msg_t _storage[2];
    msg_t *_back, *_front;
131

132 133
    mutex_t _sync;
    bool _has_msg;
134

135 136 137 138
    //  Disable copying of dbuffer.
    dbuffer_t (const dbuffer_t &);
    const dbuffer_t &operator= (const dbuffer_t &);
};
139 140 141
}

#endif