How we keep track of the readers of a gr_buffer.
More...
#include <gr_buffer.h>
List of all members.
Detailed Description
How we keep track of the readers of a gr_buffer.
Member Typedef Documentation
Constructor & Destructor Documentation
gr_buffer_reader::~gr_buffer_reader |
( |
|
) |
|
Member Function Documentation
Return buffer this reader reads from.
bool gr_buffer_reader::done |
( |
|
) |
const [inline] |
int gr_buffer_reader::items_available |
( |
|
) |
const |
Return number of items available for reading.
Return the block that reads via this reader.
int gr_buffer_reader::max_possible_items_available |
( |
|
) |
const [inline] |
Return maximum number of items that could ever be available for reading. This is used as a sanity check in the scheduler to avoid looping forever.
boost::mutex* gr_buffer_reader::mutex |
( |
|
) |
[inline] |
const void* gr_buffer_reader::read_pointer |
( |
|
) |
|
return pointer to read buffer.
The return value points to items_available() number of items
void gr_buffer_reader::set_done |
( |
bool |
done |
) |
[inline] |
void gr_buffer_reader::update_read_pointer |
( |
int |
nitems |
) |
|
Friends And Related Function Documentation
Create a new gr_buffer_reader and attach it to buffer buf
.
- Parameters:
-
| buf | is the buffer the gr_buffer_reader reads from. |
| nzero_preload | -- number of zero items to "preload" into buffer. |
| link | is the block that reads from the buffer using this gr_buffer_reader. |
The documentation for this class was generated from the following file: