classtcp__layer__factory.html 10.8 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: tcp_layer_factory 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-methods">Public Member Functions</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classtcp__layer__factory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">tcp_layer_factory Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class provides a factory class to create an <a class="el" href="classtcp__layer.html" title="Forward declaration of TITAN class. ">tcp_layer</a> class instance.  
 <a href="classtcp__layer__factory.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="tcp__layer__factory_8hh_source.html">tcp_layer_factory.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for tcp_layer_factory:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classtcp__layer__factory.png" usemap="#tcp_5Flayer_5Ffactory_map" alt=""/>
  <map id="tcp_5Flayer_5Ffactory_map" name="tcp_5Flayer_5Ffactory_map">
<area href="classlayer__factory.html" title="This class provides a factory class to create layer class instances . " alt="layer_factory" shape="rect" coords="0,0,112,24"/>
garciay's avatar
garciay committed
</map>
 </div></div>
<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:aab7fe372adef8b327518df9f0608329b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtcp__layer__factory.html#aab7fe372adef8b327518df9f0608329b">tcp_layer_factory</a> ()</td></tr>
<tr class="memdesc:aab7fe372adef8b327518df9f0608329b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to the unique instance of this class.  <a href="#aab7fe372adef8b327518df9f0608329b">More...</a><br /></td></tr>
<tr class="separator:aab7fe372adef8b327518df9f0608329b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9008f3a25e069ebe35e8fda1423226d3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlayer.html">layer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtcp__layer__factory.html#a9008f3a25e069ebe35e8fda1423226d3">create_layer</a> (const std::string &amp;p_type, const std::string &amp;p_param)</td></tr>
<tr class="memdesc:a9008f3a25e069ebe35e8fda1423226d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the layers stack based on the provided layers stack description.  <a href="#a9008f3a25e069ebe35e8fda1423226d3">More...</a><br /></td></tr>
<tr class="separator:a9008f3a25e069ebe35e8fda1423226d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
garciay's avatar
garciay committed
<tr class="inherit_header pub_methods_classlayer__factory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlayer__factory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlayer__factory.html">layer_factory</a></td></tr>
<tr class="memitem:a483ba7ff7937b7fad9da71826f7be8ad inherit pub_methods_classlayer__factory"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__factory.html#a483ba7ff7937b7fad9da71826f7be8ad">layer_factory</a> ()</td></tr>
<tr class="separator:a483ba7ff7937b7fad9da71826f7be8ad inherit pub_methods_classlayer__factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a94d1a230e3faffbaa0f5991bce493584"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classtcp__layer__factory.html">tcp_layer_factory</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtcp__layer__factory.html#a94d1a230e3faffbaa0f5991bce493584">_f</a></td></tr>
<tr class="separator:a94d1a230e3faffbaa0f5991bce493584"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides a factory class to create an <a class="el" href="classtcp__layer.html" title="Forward declaration of TITAN class. ">tcp_layer</a> class instance. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aab7fe372adef8b327518df9f0608329b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab7fe372adef8b327518df9f0608329b">&#9670;&nbsp;</a></span>tcp_layer_factory()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">tcp_layer_factory::tcp_layer_factory </td>
          <td>(</td>
          <td class="paramname"></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">

<p>Reference to the unique instance of this class. </p>
<p>Default constructor Create a new instance of the <a class="el" href="classtcp__layer.html" title="Forward declaration of TITAN class. ">tcp_layer</a> class </p><dl class="section remark"><dt>Remarks</dt><dd>The TCP socket based layer identifier is TCP </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9008f3a25e069ebe35e8fda1423226d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9008f3a25e069ebe35e8fda1423226d3">&#9670;&nbsp;</a></span>create_layer()</h2>
garciay's avatar
garciay committed

<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="classlayer.html">layer</a> * tcp_layer_factory::create_layer </td>
garciay's avatar
garciay committed
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>param</em>&#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 class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create the layers stack based on the provided layers stack description. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_type</td><td>The provided layers stack description </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_params</td><td>Optional parameters </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise </dd></dl>

<p>Implements <a class="el" href="classlayer__factory.html#af65482e4c77da879b8b3d2734a726853">layer_factory</a>.</p>
garciay's avatar
garciay committed

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a94d1a230e3faffbaa0f5991bce493584"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94d1a230e3faffbaa0f5991bce493584">&#9670;&nbsp;</a></span>_f</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="classtcp__layer__factory.html">tcp_layer_factory</a> tcp_layer_factory::_f</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><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="tcp__layer__factory_8hh_source.html">tcp_layer_factory.hh</a></li>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/src/<a class="el" href="tcp__layer_8cc.html">tcp_layer.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:36 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>