classPacketHeaderDescr.html 15.3 KB
Newer Older
garciay's avatar
garciay committed
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ETSI STF525 / Internal Testing test suite: PacketHeaderDescr Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ETSI STF525 / Internal Testing test suite
   </div>
   <div id="projectbrief">This project provides an internal testing test suite and its associated Test Adapter/Codec</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPacketHeaderDescr-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PacketHeaderDescr Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="Abstract__Socket_8hh_source.html">Abstract_Socket.hh</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a22d349456872f0919bfcd59bdcfb511c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511c">HeaderByteOrder</a> { <a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511ca7d94f5d6d106289d97d24ef8d1e6659d">Header_MSB</a>, 
<a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511ca3b495404b59b0b338c30121c5f4e9633">Header_LSB</a>
 }</td></tr>
<tr class="separator:a22d349456872f0919bfcd59bdcfb511c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa6b1ba6ce95fd3cd07e7fd2493d026a0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#aa6b1ba6ce95fd3cd07e7fd2493d026a0">PacketHeaderDescr</a> (unsigned long p_length_offset, unsigned long p_nr_bytes_in_length, <a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511c">HeaderByteOrder</a> p_byte_order, long p_value_offset=0, unsigned long p_length_multiplier=1)</td></tr>
<tr class="separator:aa6b1ba6ce95fd3cd07e7fd2493d026a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a790158096571af23a03edd2206aa7258"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#a790158096571af23a03edd2206aa7258">Get_Message_Length</a> (const unsigned char *buffer_pointer) const</td></tr>
<tr class="separator:a790158096571af23a03edd2206aa7258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6a823cefbeda5a2b053f8605edd3d9a"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#aa6a823cefbeda5a2b053f8605edd3d9a">Get_Valid_Header_Length</a> () const</td></tr>
<tr class="separator:aa6a823cefbeda5a2b053f8605edd3d9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a31a9c71eb97c6d16bc1e58689af23b6c"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#a31a9c71eb97c6d16bc1e58689af23b6c">length_offset</a></td></tr>
<tr class="separator:a31a9c71eb97c6d16bc1e58689af23b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9708dbfbaa1b8a6e7d1b7e99649f86a"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#af9708dbfbaa1b8a6e7d1b7e99649f86a">nr_bytes_in_length</a></td></tr>
<tr class="separator:af9708dbfbaa1b8a6e7d1b7e99649f86a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb12ebdfdadaee8dfc85097c07048a97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511c">HeaderByteOrder</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#acb12ebdfdadaee8dfc85097c07048a97">byte_order</a></td></tr>
<tr class="separator:acb12ebdfdadaee8dfc85097c07048a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d593784778692db9e0da0ebed217f1"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#a34d593784778692db9e0da0ebed217f1">value_offset</a></td></tr>
<tr class="separator:a34d593784778692db9e0da0ebed217f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31f6ade6c6389111fbd67220105c4dc7"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPacketHeaderDescr.html#a31f6ade6c6389111fbd67220105c4dc7">length_multiplier</a></td></tr>
<tr class="separator:a31f6ade6c6389111fbd67220105c4dc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a22d349456872f0919bfcd59bdcfb511c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22d349456872f0919bfcd59bdcfb511c">&#9670;&nbsp;</a></span>HeaderByteOrder</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511c">PacketHeaderDescr::HeaderByteOrder</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a22d349456872f0919bfcd59bdcfb511ca7d94f5d6d106289d97d24ef8d1e6659d"></a>Header_MSB&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a22d349456872f0919bfcd59bdcfb511ca3b495404b59b0b338c30121c5f4e9633"></a>Header_LSB&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa6b1ba6ce95fd3cd07e7fd2493d026a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6b1ba6ce95fd3cd07e7fd2493d026a0">&#9670;&nbsp;</a></span>PacketHeaderDescr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PacketHeaderDescr::PacketHeaderDescr </td>
          <td>(</td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>p_length_offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>p_nr_bytes_in_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511c">HeaderByteOrder</a>&#160;</td>
          <td class="paramname"><em>p_byte_order</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>p_value_offset</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>p_length_multiplier</em> = <code>1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a790158096571af23a03edd2206aa7258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a790158096571af23a03edd2206aa7258">&#9670;&nbsp;</a></span>Get_Message_Length()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long PacketHeaderDescr::Get_Message_Length </td>
          <td>(</td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>buffer_pointer</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aa6a823cefbeda5a2b053f8605edd3d9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6a823cefbeda5a2b053f8605edd3d9a">&#9670;&nbsp;</a></span>Get_Valid_Header_Length()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long PacketHeaderDescr::Get_Valid_Header_Length </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acb12ebdfdadaee8dfc85097c07048a97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb12ebdfdadaee8dfc85097c07048a97">&#9670;&nbsp;</a></span>byte_order</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPacketHeaderDescr.html#a22d349456872f0919bfcd59bdcfb511c">HeaderByteOrder</a> PacketHeaderDescr::byte_order</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a31f6ade6c6389111fbd67220105c4dc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31f6ade6c6389111fbd67220105c4dc7">&#9670;&nbsp;</a></span>length_multiplier</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long PacketHeaderDescr::length_multiplier</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a31a9c71eb97c6d16bc1e58689af23b6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31a9c71eb97c6d16bc1e58689af23b6c">&#9670;&nbsp;</a></span>length_offset</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long PacketHeaderDescr::length_offset</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="af9708dbfbaa1b8a6e7d1b7e99649f86a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9708dbfbaa1b8a6e7d1b7e99649f86a">&#9670;&nbsp;</a></span>nr_bytes_in_length</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long PacketHeaderDescr::nr_bytes_in_length</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a34d593784778692db9e0da0ebed217f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34d593784778692db9e0da0ebed217f1">&#9670;&nbsp;</a></span>value_offset</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long PacketHeaderDescr::value_offset</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/include/<a class="el" href="Abstract__Socket_8hh_source.html">Abstract_Socket.hh</a></li>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/src/<a class="el" href="Abstract__Socket_8cc.html">Abstract_Socket.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:34 for ETSI STF525 / Internal Testing test suite by &#160;<a href="http://www.doxygen.org/index.html">
garciay's avatar
garciay committed
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>