gr_buffer.h File Reference

#include <gr_runtime_types.h>

Include dependency graph for gr_buffer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	gr_buffer
	Single writer, multiple reader fifo. More...
class	gr_buffer_reader
	How we keep track of the readers of a gr_buffer. More...
Functions
gr_buffer_sptr	gr_make_buffer (int nitems, size_t sizeof_item)
	Allocate a buffer that holds at least nitems of size sizeof_item.
gr_buffer_reader_sptr	gr_buffer_add_reader (gr_buffer_sptr buf, int nzero_preload)
	create a new gr_buffer_reader and attach it to buffer buf
long	gr_buffer_ncurrently_allocated ()
	returns # of gr_buffers currently allocated
long	gr_buffer_reader_ncurrently_allocated ()
	returns # of gr_buffer_readers currently allocated

---

Function Documentation

gr_buffer_reader_sptr gr_buffer_add_reader	(	gr_buffer_sptr	buf,
		int	nzero_preload
	)

create a new gr_buffer_reader and attach it to buffer buf

Parameters:

nzero_preload

-- number of zero items to "preload" into buffer.

long gr_buffer_ncurrently_allocated

(

)

returns # of gr_buffers currently allocated

long gr_buffer_reader_ncurrently_allocated

(

)

returns # of gr_buffer_readers currently allocated

gr_buffer_sptr gr_make_buffer	(	int	nitems,
		size_t	sizeof_item
	)

Allocate a buffer that holds at least nitems of size sizeof_item.

The total size of the buffer will be rounded up to a system dependent boundary. This is typically the system page size, but under MS windows is 64KB.