blob: d1deece9686d186ac5834ed1afb60f6d1d33939c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
//
// Copyright 2010 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef INCLUDED_UHD_TRANSPORT_BOUNDED_BUFFER_HPP
#define INCLUDED_UHD_TRANSPORT_BOUNDED_BUFFER_HPP
#include <uhd/config.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/date_time/posix_time/posix_time_types.hpp>
namespace uhd{ namespace transport{
//! typedef for the time duration type for wait operations
typedef boost::posix_time::time_duration time_duration_t;
/*!
* Implement a templated bounded buffer:
* Used for passing elements between threads in a producer-consumer model.
* The bounded buffer implemented waits and timed waits with condition variables.
* The pop operation blocks on the bounded_buffer to become non empty.
* The push operation blocks on the bounded_buffer to become non full.
*/
template <typename elem_type> class bounded_buffer{
public:
typedef boost::shared_ptr<bounded_buffer<elem_type> > sptr;
/*!
* Make a new bounded buffer object.
* \param capacity the bounded_buffer capacity
*/
static sptr make(size_t capacity);
/*!
* Push a new element into the bounded buffer.
* If the buffer is full prior to the push,
* make room by poping the oldest element.
* \param elem the new element to push
* \return true if the element fit without popping for space
*/
virtual bool push_with_pop_on_full(const elem_type &elem) = 0;
/*!
* Push a new element into the bounded_buffer.
* Wait until the bounded_buffer becomes non-full.
* \param elem the new element to push
*/
virtual void push_with_wait(const elem_type &elem) = 0;
/*!
* Push a new element into the bounded_buffer.
* Wait until the bounded_buffer becomes non-full or timeout.
* \param elem the new element to push
* \param time the timeout time
* \return false when the operation times out
*/
virtual bool push_with_timed_wait(const elem_type &elem, const time_duration_t &time) = 0;
/*!
* Pop an element from the bounded_buffer.
* Wait until the bounded_buffer becomes non-empty.
* \param elem the element reference pop to
*/
virtual void pop_with_wait(elem_type &elem) = 0;
/*!
* Pop an element from the bounded_buffer.
* Wait until the bounded_buffer becomes non-empty or timeout.
* \param elem the element reference pop to
* \param time the timeout time
* \return false when the operation times out
*/
virtual bool pop_with_timed_wait(elem_type &elem, const time_duration_t &time) = 0;
/*!
* Clear all elements from the bounded_buffer.
*/
virtual void clear(void) = 0;
};
}} //namespace
#include <uhd/transport/bounded_buffer.ipp>
#endif /* INCLUDED_UHD_TRANSPORT_BOUNDED_BUFFER_HPP */
|
