<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU Radio 3.3.0 C++ API: gr_packet_sink Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="contents"> <h1>gr_packet_sink Class Reference<br/> <small> [<a class="el" href="group__sink__blk.html">Signal Sinks</a>]</small> </h1><!-- doxytag: class="gr_packet_sink" --><!-- doxytag: inherits="gr_sync_block" --> <p>process received bits looking for packet sync, header, and process bits into packet <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__packet__sink_8h_source.html">gr_packet_sink.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_packet_sink:</div> <div class="dynsection"> <div class="center"><img src="classgr__packet__sink__inherit__graph.png" border="0" usemap="#gr__packet__sink_inherit__map" alt="Inheritance graph"/></div> <map name="gr__packet__sink_inherit__map" id="gr__packet__sink_inherit__map"> <area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="21,315,128,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="40,237,109,267"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="20,160,129,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="13,83,136,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__packet__sink-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a7ce964ea98fb65ca99d6d8c605ec14e7">~gr_packet_sink</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a935f2f31a4bb191cdc40a7e890248d24">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a935f2f31a4bb191cdc40a7e890248d24"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a1973dc6af65d665e487f9e8a7d9d4c1e">carrier_sensed</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return true if we detect carrier <a href="#a1973dc6af65d665e487f9e8a7d9d4c1e"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#aca3162215b64abe275567f55fd7533d0">gr_packet_sink</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< unsigned char > &sync_vector, <a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue, int threshold)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a51919fbafd2e9e6d57e08e37c79852cb">enter_search</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a7479c5de3faa20374784d735b100120f">enter_have_sync</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#accc43f02145a1f6b3375a62630bcd533">enter_have_header</a> (int payload_len)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#aed0e4f3003504d421ea816c7c0237a74">slice</a> (float x)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a8113a705c44649c925447ced61fb4c67">header_ok</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a626be5e11e812b81a7c3670770a94234">header_payload_len</a> ()</td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_packet_sink_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packet__sink.html#a011d6a76fc380c53c7a663d693e74b2f">gr_make_packet_sink</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< unsigned char > &sync_vector, <a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue, int threshold)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>process received bits looking for packet sync, header, and process bits into packet </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aca3162215b64abe275567f55fd7533d0"></a><!-- doxytag: member="gr_packet_sink::gr_packet_sink" ref="aca3162215b64abe275567f55fd7533d0" args="(const std::vector< unsigned char > &sync_vector, gr_msg_queue_sptr target_queue, int threshold)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_packet_sink::gr_packet_sink </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< unsigned char > & </td> <td class="paramname"> <em>sync_vector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> </td> <td class="paramname"> <em>target_queue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>threshold</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a7ce964ea98fb65ca99d6d8c605ec14e7"></a><!-- doxytag: member="gr_packet_sink::~gr_packet_sink" ref="a7ce964ea98fb65ca99d6d8c605ec14e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_packet_sink::~gr_packet_sink </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a1973dc6af65d665e487f9e8a7d9d4c1e"></a><!-- doxytag: member="gr_packet_sink::carrier_sensed" ref="a1973dc6af65d665e487f9e8a7d9d4c1e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_packet_sink::carrier_sensed </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>return true if we detect carrier </p> </div> </div> <a class="anchor" id="accc43f02145a1f6b3375a62630bcd533"></a><!-- doxytag: member="gr_packet_sink::enter_have_header" ref="accc43f02145a1f6b3375a62630bcd533" args="(int payload_len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_packet_sink::enter_have_header </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>payload_len</em></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a7479c5de3faa20374784d735b100120f"></a><!-- doxytag: member="gr_packet_sink::enter_have_sync" ref="a7479c5de3faa20374784d735b100120f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_packet_sink::enter_have_sync </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a51919fbafd2e9e6d57e08e37c79852cb"></a><!-- doxytag: member="gr_packet_sink::enter_search" ref="a51919fbafd2e9e6d57e08e37c79852cb" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_packet_sink::enter_search </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8113a705c44649c925447ced61fb4c67"></a><!-- doxytag: member="gr_packet_sink::header_ok" ref="a8113a705c44649c925447ced61fb4c67" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_packet_sink::header_ok </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a626be5e11e812b81a7c3670770a94234"></a><!-- doxytag: member="gr_packet_sink::header_payload_len" ref="a626be5e11e812b81a7c3670770a94234" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_packet_sink::header_payload_len </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aed0e4f3003504d421ea816c7c0237a74"></a><!-- doxytag: member="gr_packet_sink::slice" ref="aed0e4f3003504d421ea816c7c0237a74" args="(float x)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_packet_sink::slice </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>x</em></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a935f2f31a4bb191cdc40a7e890248d24"></a><!-- doxytag: member="gr_packet_sink::work" ref="a935f2f31a4bb191cdc40a7e890248d24" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_packet_sink::work </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>noutput_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td> <td class="paramname"> <em>input_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td> <td class="paramname"> <em>output_items</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p> <p>The user must override work to define the signal processing code </p> <p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a011d6a76fc380c53c7a663d693e74b2f"></a><!-- doxytag: member="gr_packet_sink::gr_make_packet_sink" ref="a011d6a76fc380c53c7a663d693e74b2f" args="(const std::vector< unsigned char > &sync_vector, gr_msg_queue_sptr target_queue, int threshold)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_packet_sink_sptr</a> gr_make_packet_sink </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< unsigned char > & </td> <td class="paramname"> <em>sync_vector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> </td> <td class="paramname"> <em>target_queue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>threshold</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__packet__sink_8h_source.html">gr_packet_sink.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:52 2010 for GNU Radio 3.3.0 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>