Files
OpenNetworkLinux/onlp/doxygen/html/group__oid-module.html
Jeffrey Townsend 3c6d56fd43 Testing
2019-05-29 16:38:03 +00:00

389 lines
20 KiB
HTML

<!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>ONLP: Modules</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">ONLP
</div>
<div id="projectbrief">Open Network Linux Platform APIs</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Modules<div class="ingroups"><a class="el" href="group__onlp-main.html">ONLP</a> &raquo; <a class="el" href="group__onlp-appication.html">ONLP Application Interfaces</a> &raquo; <a class="el" href="group__oid-types.html">OID Types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structonlp__module__info__s.html">onlp_module_info_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module OID Information Structure. <a href="structonlp__module__info__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga246953cdb6be7b83bac70f0b1d7c297a"><td class="memItemLeft" align="right" valign="top"><a id="ga246953cdb6be7b83bac70f0b1d7c297a"></a>
typedef struct <a class="el" href="structonlp__module__info__s.html">onlp_module_info_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a></td></tr>
<tr class="memdesc:ga246953cdb6be7b83bac70f0b1d7c297a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module OID Information Structure. <br /></td></tr>
<tr class="separator:ga246953cdb6be7b83bac70f0b1d7c297a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf0fffd240af6133de708bd5826d6b53b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#gaf0fffd240af6133de708bd5826d6b53b">onlp_module_sw_init</a> (void)</td></tr>
<tr class="memdesc:gaf0fffd240af6133de708bd5826d6b53b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the module software module. <a href="#gaf0fffd240af6133de708bd5826d6b53b">More...</a><br /></td></tr>
<tr class="separator:gaf0fffd240af6133de708bd5826d6b53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4eb92a50197927c4073ad9834f63313f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#ga4eb92a50197927c4073ad9834f63313f">onlp_module_hw_init</a> (uint32_t flags)</td></tr>
<tr class="memdesc:ga4eb92a50197927c4073ad9834f63313f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the module. <a href="#ga4eb92a50197927c4073ad9834f63313f">More...</a><br /></td></tr>
<tr class="separator:ga4eb92a50197927c4073ad9834f63313f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcf71feb9c8da89f6c5d1d474aa08c86"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#gafcf71feb9c8da89f6c5d1d474aa08c86">onlp_module_sw_denit</a> (void)</td></tr>
<tr class="memdesc:gafcf71feb9c8da89f6c5d1d474aa08c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitialize the module software module. <a href="#gafcf71feb9c8da89f6c5d1d474aa08c86">More...</a><br /></td></tr>
<tr class="separator:gafcf71feb9c8da89f6c5d1d474aa08c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1703816dc97c5bc733eaefd64274405"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#gac1703816dc97c5bc733eaefd64274405">onlp_module_hdr_get</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, <a class="el" href="group__oid.html#ga6496740949b7893b4122857837e26b37">onlp_oid_hdr_t</a> *hdr)</td></tr>
<tr class="memdesc:gac1703816dc97c5bc733eaefd64274405"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the module header structure. <a href="#gac1703816dc97c5bc733eaefd64274405">More...</a><br /></td></tr>
<tr class="separator:gac1703816dc97c5bc733eaefd64274405"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadca3359f4cf0aa19c79e5b64f8f32eba"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#gadca3359f4cf0aa19c79e5b64f8f32eba">onlp_module_info_get</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, <a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *info)</td></tr>
<tr class="memdesc:gadca3359f4cf0aa19c79e5b64f8f32eba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the module info structure. <a href="#gadca3359f4cf0aa19c79e5b64f8f32eba">More...</a><br /></td></tr>
<tr class="separator:gadca3359f4cf0aa19c79e5b64f8f32eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa6c560b25a4d38d5ad373e266c671f54"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#gaa6c560b25a4d38d5ad373e266c671f54">onlp_module_info_to_user_json</a> (<a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *info, cJSON **rv, uint32_t flags)</td></tr>
<tr class="memdesc:gaa6c560b25a4d38d5ad373e266c671f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a module info structure to user JSON. <a href="#gaa6c560b25a4d38d5ad373e266c671f54">More...</a><br /></td></tr>
<tr class="separator:gaa6c560b25a4d38d5ad373e266c671f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17d1a205aa97e17304f55f44b29a458d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#ga17d1a205aa97e17304f55f44b29a458d">onlp_module_info_to_json</a> (<a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *info, cJSON **rv, uint32_t flags)</td></tr>
<tr class="memdesc:ga17d1a205aa97e17304f55f44b29a458d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a module info structure to JSON. <a href="#ga17d1a205aa97e17304f55f44b29a458d">More...</a><br /></td></tr>
<tr class="separator:ga17d1a205aa97e17304f55f44b29a458d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae20051e9ae1b103aefadb85a32331aa2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oid-module.html#gae20051e9ae1b103aefadb85a32331aa2">onlp_module_info_from_json</a> (cJSON *cj, <a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *info)</td></tr>
<tr class="memdesc:gae20051e9ae1b103aefadb85a32331aa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a JSON object to a module info structure. <a href="#gae20051e9ae1b103aefadb85a32331aa2">More...</a><br /></td></tr>
<tr class="separator:gae20051e9ae1b103aefadb85a32331aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac1703816dc97c5bc733eaefd64274405"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1703816dc97c5bc733eaefd64274405">&#9670;&nbsp;</a></span>onlp_module_hdr_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_hdr_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a>&#160;</td>
<td class="paramname"><em>oid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oid.html#ga6496740949b7893b4122857837e26b37">onlp_oid_hdr_t</a> *&#160;</td>
<td class="paramname"><em>hdr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the module header structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">oid</td><td>The Module oid. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">hdr</td><td>Receives the header. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4eb92a50197927c4073ad9834f63313f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4eb92a50197927c4073ad9834f63313f">&#9670;&nbsp;</a></span>onlp_module_hw_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_hw_init </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>The initialization flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae20051e9ae1b103aefadb85a32331aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae20051e9ae1b103aefadb85a32331aa2">&#9670;&nbsp;</a></span>onlp_module_info_from_json()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_info_from_json </td>
<td>(</td>
<td class="paramtype">cJSON *&#160;</td>
<td class="paramname"><em>cj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *&#160;</td>
<td class="paramname"><em>info</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a JSON object to a module info structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">cj</td><td>The JSON object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>Receives the module info structure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gadca3359f4cf0aa19c79e5b64f8f32eba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadca3359f4cf0aa19c79e5b64f8f32eba">&#9670;&nbsp;</a></span>onlp_module_info_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_info_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a>&#160;</td>
<td class="paramname"><em>oid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *&#160;</td>
<td class="paramname"><em>info</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the module info structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">oid</td><td>The Module oid. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga17d1a205aa97e17304f55f44b29a458d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17d1a205aa97e17304f55f44b29a458d">&#9670;&nbsp;</a></span>onlp_module_info_to_json()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_info_to_json </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *&#160;</td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cJSON **&#160;</td>
<td class="paramname"><em>rv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a module info structure to JSON. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">info</td><td>The module info structure. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">rv</td><td>Receives the JSON object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">flags</td><td>The JSON format flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa6c560b25a4d38d5ad373e266c671f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6c560b25a4d38d5ad373e266c671f54">&#9670;&nbsp;</a></span>onlp_module_info_to_user_json()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_info_to_user_json </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *&#160;</td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cJSON **&#160;</td>
<td class="paramname"><em>rv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a module info structure to user JSON. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">info</td><td>The module info structure. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">rv</td><td>Receives the JSON object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">flags</td><td>The JSON format flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafcf71feb9c8da89f6c5d1d474aa08c86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafcf71feb9c8da89f6c5d1d474aa08c86">&#9670;&nbsp;</a></span>onlp_module_sw_denit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_sw_denit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitialize the module software module. </p>
<dl class="section note"><dt>Note</dt><dd>The primary purpose of this API is to properly deallocate any resources used by the module in order faciliate detection of real resouce leaks. </dd></dl>
</div>
</div>
<a id="gaf0fffd240af6133de708bd5826d6b53b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0fffd240af6133de708bd5826d6b53b">&#9670;&nbsp;</a></span>onlp_module_sw_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_module_sw_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the module software module. </p>
<dl class="section note"><dt>Note</dt><dd>This will be called at software initialization time. This should not initialize any hardware. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 29 2019 16:19:08 for ONLP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>