mirror of
https://github.com/Telecominfraproject/OpenNetworkLinux.git
synced 2025-12-27 18:25:00 +00:00
136 lines
11 KiB
HTML
136 lines
11 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: module/inc/onlp/module.h File 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">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>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a7b0466279106ea0b8f86f609f621680.html">module</a></li><li class="navelem"><a class="el" href="dir_9b91cb305f6dfd5edb8153d5019adc55.html">inc</a></li><li class="navelem"><a class="el" href="dir_72adef417dcbc5bf8193445c31305165.html">onlp</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">module.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Module OID Interface.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="onlp__config_8h_source.html">onlp/onlp_config.h</a>></code><br />
|
|
<code>#include <onlp/onlp.h></code><br />
|
|
<code>#include <onlplib/onie.h></code><br />
|
|
<code>#include <onlplib/pi.h></code><br />
|
|
<code>#include <<a class="el" href="oids_8h_source.html">onlp/oids.h</a>></code><br />
|
|
</div>
|
|
<p><a href="module_8h_source.html">Go to the source code of this file.</a></p>
|
|
<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  </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"> </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"> </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">
|
|
typedef struct <a class="el" href="structonlp__module__info__s.html">onlp_module_info_s</a> </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"> </td><td class="mdescRight">Module OID Information Structure. <br /></td></tr>
|
|
<tr class="separator:ga246953cdb6be7b83bac70f0b1d7c297a"><td class="memSeparator" colspan="2"> </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 </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"> </td><td class="mdescRight">Initialize the module software module. <a href="group__oid-module.html#gaf0fffd240af6133de708bd5826d6b53b">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf0fffd240af6133de708bd5826d6b53b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4eb92a50197927c4073ad9834f63313f"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Initialize the module. <a href="group__oid-module.html#ga4eb92a50197927c4073ad9834f63313f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4eb92a50197927c4073ad9834f63313f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafcf71feb9c8da89f6c5d1d474aa08c86"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Deinitialize the module software module. <a href="group__oid-module.html#gafcf71feb9c8da89f6c5d1d474aa08c86">More...</a><br /></td></tr>
|
|
<tr class="separator:gafcf71feb9c8da89f6c5d1d474aa08c86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac1703816dc97c5bc733eaefd64274405"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Get the module header structure. <a href="group__oid-module.html#gac1703816dc97c5bc733eaefd64274405">More...</a><br /></td></tr>
|
|
<tr class="separator:gac1703816dc97c5bc733eaefd64274405"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadca3359f4cf0aa19c79e5b64f8f32eba"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Get the module info structure. <a href="group__oid-module.html#gadca3359f4cf0aa19c79e5b64f8f32eba">More...</a><br /></td></tr>
|
|
<tr class="separator:gadca3359f4cf0aa19c79e5b64f8f32eba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa6c560b25a4d38d5ad373e266c671f54"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Convert a module info structure to user JSON. <a href="group__oid-module.html#gaa6c560b25a4d38d5ad373e266c671f54">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa6c560b25a4d38d5ad373e266c671f54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga17d1a205aa97e17304f55f44b29a458d"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Convert a module info structure to JSON. <a href="group__oid-module.html#ga17d1a205aa97e17304f55f44b29a458d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga17d1a205aa97e17304f55f44b29a458d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae20051e9ae1b103aefadb85a32331aa2"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Convert a JSON object to a module info structure. <a href="group__oid-module.html#gae20051e9ae1b103aefadb85a32331aa2">More...</a><br /></td></tr>
|
|
<tr class="separator:gae20051e9ae1b103aefadb85a32331aa2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Module OID Interface. </p>
|
|
</div></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed May 29 2019 16:19:07 for ONLP by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|