<?xml version='1.0' encoding='UTF-8' standalone='no'?> <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.2"> <compounddef id="gr__buffer_8h" kind="file"> <compoundname>gr_buffer.h</compoundname> <includes refid="gr__runtime__types_8h" local="no">gr_runtime_types.h</includes> <includes local="no">boost/weak_ptr.hpp</includes> <includes local="no">boost/thread.hpp</includes> <includedby refid="gri__logger_8h" local="no">gri_logger.h</includedby> <includedby refid="audio__portaudio__sink_8h" local="no">audio_portaudio_sink.h</includedby> <includedby refid="audio__portaudio__source_8h" local="no">audio_portaudio_source.h</includedby> <incdepgraph> <node id="13501"> <label>boost/shared_ptr.hpp</label> </node> <node id="13498"> <label>gr_buffer.h</label> <link refid="gr_buffer.h"/> <childnode refid="13499" relation="include"> </childnode> <childnode refid="13507" relation="include"> </childnode> <childnode refid="13508" relation="include"> </childnode> </node> <node id="13500"> <label>gr_types.h</label> <link refid="gr__types_8h"/> <childnode refid="13501" relation="include"> </childnode> <childnode refid="13502" relation="include"> </childnode> <childnode refid="13503" relation="include"> </childnode> <childnode refid="13504" relation="include"> </childnode> <childnode refid="13506" relation="include"> </childnode> </node> <node id="13506"> <label>stdint.h</label> </node> <node id="13507"> <label>boost/weak_ptr.hpp</label> </node> <node id="13508"> <label>boost/thread.hpp</label> </node> <node id="13503"> <label>stddef.h</label> </node> <node id="13502"> <label>vector</label> </node> <node id="13504"> <label>gr_complex.h</label> <link refid="gr__complex_8h"/> <childnode refid="13505" relation="include"> </childnode> </node> <node id="13499"> <label>gr_runtime_types.h</label> <link refid="gr__runtime__types_8h"/> <childnode refid="13500" relation="include"> </childnode> </node> <node id="13505"> <label>complex</label> </node> </incdepgraph> <invincdepgraph> <node id="13509"> <label>gr_buffer.h</label> <link refid="gr_buffer.h"/> <childnode refid="13510" relation="include"> </childnode> <childnode refid="13511" relation="include"> </childnode> <childnode refid="13512" relation="include"> </childnode> </node> <node id="13511"> <label>audio_portaudio_sink.h</label> <link refid="audio__portaudio__sink_8h"/> </node> <node id="13512"> <label>audio_portaudio_source.h</label> <link refid="audio__portaudio__source_8h"/> </node> <node id="13510"> <label>gri_logger.h</label> <link refid="gri__logger_8h"/> <childnode refid="13511" relation="include"> </childnode> <childnode refid="13512" relation="include"> </childnode> </node> </invincdepgraph> <innerclass refid="classgr__buffer" prot="public">gr_buffer</innerclass> <innerclass refid="classgr__buffer__reader" prot="public">gr_buffer_reader</innerclass> <sectiondef kind="func"> <memberdef kind="function" id="gr__buffer_8h_1aebc8f592465e520011dc5eb872b1a5e7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type> <definition>gr_buffer_sptr gr_make_buffer</definition> <argsstring>(int nitems, size_t sizeof_item, gr_block_sptr link=gr_block_sptr())</argsstring> <name>gr_make_buffer</name> <param> <type>int</type> <declname>nitems</declname> </param> <param> <type>size_t</type> <declname>sizeof_item</declname> </param> <param> <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref></type> <declname>link</declname> <defval><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref>()</defval> </param> <briefdescription> <para>Allocate a buffer that holds at least <computeroutput>nitems</computeroutput> of size <computeroutput>sizeof_item</computeroutput>. </para> </briefdescription> <detaileddescription> <para>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.</para><para><parameterlist kind="param"><parameteritem> <parameternamelist> <parametername>nitems</parametername> </parameternamelist> <parameterdescription> <para>is the minimum number of items the buffer will hold. </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>sizeof_item</parametername> </parameternamelist> <parameterdescription> <para>is the size of an item in bytes. </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>link</parametername> </parameternamelist> <parameterdescription> <para>is the block that writes to this buffer. </para></parameterdescription> </parameteritem> </parameterlist> </para> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="43"/> </memberdef> <memberdef kind="function" id="gr__buffer_8h_1aa5e3f8c5b81a3b5395efb545e5b56613" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_reader_sptr</ref></type> <definition>gr_buffer_reader_sptr gr_buffer_add_reader</definition> <argsstring>(gr_buffer_sptr buf, int nzero_preload, gr_block_sptr link=gr_block_sptr())</argsstring> <name>gr_buffer_add_reader</name> <param> <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type> <declname>buf</declname> </param> <param> <type>int</type> <declname>nzero_preload</declname> </param> <param> <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref></type> <declname>link</declname> <defval><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref>()</defval> </param> <briefdescription> <para>Create a new <ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref> and attach it to buffer <computeroutput>buf</computeroutput>. </para> </briefdescription> <detaileddescription> <para><parameterlist kind="param"><parameteritem> <parameternamelist> <parametername>buf</parametername> </parameternamelist> <parameterdescription> <para>is the buffer the <computeroutput><ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref></computeroutput> reads from. </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>nzero_preload</parametername> </parameternamelist> <parameterdescription> <para>-- number of zero items to "preload" into buffer. </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>link</parametername> </parameternamelist> <parameterdescription> <para>is the block that reads from the buffer using this <ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref>. </para></parameterdescription> </parameteritem> </parameterlist> </para> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="172"/> </memberdef> <memberdef kind="function" id="gr__buffer_8h_1aa863a94ed8f87b2603df59e7b0eeed37" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> <type>long</type> <definition>long gr_buffer_ncurrently_allocated</definition> <argsstring>()</argsstring> <name>gr_buffer_ncurrently_allocated</name> <briefdescription> <para>returns # of gr_buffers currently allocated </para> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="175"/> </memberdef> <memberdef kind="function" id="gr__buffer_8h_1a229e8245902aa53c7fe9644c2fc6f3a9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> <type>long</type> <definition>long gr_buffer_reader_ncurrently_allocated</definition> <argsstring>()</argsstring> <name>gr_buffer_reader_ncurrently_allocated</name> <briefdescription> <para>returns # of gr_buffer_readers currently allocated </para> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="250"/> </memberdef> </sectiondef> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h"/> </compounddef> </doxygen>