mirror of
https://github.com/Telecominfraproject/OpenNetworkLinux.git
synced 2026-01-10 01:01:34 +00:00
358 lines
18 KiB
HTML
358 lines
18 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: attributei</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="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">attributei<div class="ingroups"><a class="el" href="group__onlp-main.html">ONLP</a> » <a class="el" href="group__onlp-platform.html">Platform Implementation Interfaces</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga4e9095cbcec19cf629fc4ce70a644c13"><td class="memItemLeft" align="right" valign="top"><a id="ga4e9095cbcec19cf629fc4ce70a644c13"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#ga4e9095cbcec19cf629fc4ce70a644c13">onlp_attributei_sw_init</a> (void)</td></tr>
|
|
<tr class="memdesc:ga4e9095cbcec19cf629fc4ce70a644c13"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the attribute subsystem. <br /></td></tr>
|
|
<tr class="separator:ga4e9095cbcec19cf629fc4ce70a644c13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7d57c3e5b1796cef1f4723f965e6fe33"><td class="memItemLeft" align="right" valign="top"><a id="ga7d57c3e5b1796cef1f4723f965e6fe33"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#ga7d57c3e5b1796cef1f4723f965e6fe33">onlp_attributei_hw_init</a> (uint32_t flags)</td></tr>
|
|
<tr class="memdesc:ga7d57c3e5b1796cef1f4723f965e6fe33"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the attribute subsystem. <br /></td></tr>
|
|
<tr class="separator:ga7d57c3e5b1796cef1f4723f965e6fe33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga45f80dcf3c647e77062f0f09abcd8729"><td class="memItemLeft" align="right" valign="top"><a id="ga45f80dcf3c647e77062f0f09abcd8729"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#ga45f80dcf3c647e77062f0f09abcd8729">onlp_attributei_sw_denit</a> (void)</td></tr>
|
|
<tr class="memdesc:ga45f80dcf3c647e77062f0f09abcd8729"><td class="mdescLeft"> </td><td class="mdescRight">Deinitialize the attribute subsystem. <br /></td></tr>
|
|
<tr class="separator:ga45f80dcf3c647e77062f0f09abcd8729"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaabb6e25906d2ff17331ac7900cec62d9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#gaabb6e25906d2ff17331ac7900cec62d9">onlp_attributei_supported</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, const char *attribute)</td></tr>
|
|
<tr class="memdesc:gaabb6e25906d2ff17331ac7900cec62d9"><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the OID supports the given attributei. <a href="#gaabb6e25906d2ff17331ac7900cec62d9">More...</a><br /></td></tr>
|
|
<tr class="separator:gaabb6e25906d2ff17331ac7900cec62d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga31e4c462f109756375c7cf69b1139bba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#ga31e4c462f109756375c7cf69b1139bba">onlp_attributei_set</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, const char *attribute, void *value)</td></tr>
|
|
<tr class="memdesc:ga31e4c462f109756375c7cf69b1139bba"><td class="mdescLeft"> </td><td class="mdescRight">Set an attribute on the given OID. <a href="#ga31e4c462f109756375c7cf69b1139bba">More...</a><br /></td></tr>
|
|
<tr class="separator:ga31e4c462f109756375c7cf69b1139bba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaecba73893c74bc1e994710bd4817b3e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#gaaecba73893c74bc1e994710bd4817b3e">onlp_attributei_get</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, const char *attribute, void **value)</td></tr>
|
|
<tr class="memdesc:gaaecba73893c74bc1e994710bd4817b3e"><td class="mdescLeft"> </td><td class="mdescRight">Get an attribute from the given OID. <a href="#gaaecba73893c74bc1e994710bd4817b3e">More...</a><br /></td></tr>
|
|
<tr class="separator:gaaecba73893c74bc1e994710bd4817b3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1ff39f9833ecd101e98b2d6a7f3c81b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#gaa1ff39f9833ecd101e98b2d6a7f3c81b">onlp_attributei_free</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, const char *attribute, void *value)</td></tr>
|
|
<tr class="memdesc:gaa1ff39f9833ecd101e98b2d6a7f3c81b"><td class="mdescLeft"> </td><td class="mdescRight">Free an attribute value returned from <a class="el" href="group__attributei.html#gaaecba73893c74bc1e994710bd4817b3e" title="Get an attribute from the given OID. ">onlp_attributei_get()</a>. <a href="#gaa1ff39f9833ecd101e98b2d6a7f3c81b">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa1ff39f9833ecd101e98b2d6a7f3c81b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab88e01ee2c3c443b071c063ed80bdd33"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#gab88e01ee2c3c443b071c063ed80bdd33">onlp_attributei_onie_info_get</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, onlp_onie_info_t *rv)</td></tr>
|
|
<tr class="memdesc:gab88e01ee2c3c443b071c063ed80bdd33"><td class="mdescLeft"> </td><td class="mdescRight">Get an OID's ONIE attribute. <a href="#gab88e01ee2c3c443b071c063ed80bdd33">More...</a><br /></td></tr>
|
|
<tr class="separator:gab88e01ee2c3c443b071c063ed80bdd33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaacc08958c1915162b5b0e004cfb724a7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributei.html#gaacc08958c1915162b5b0e004cfb724a7">onlp_attributei_asset_info_get</a> (<a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, <a class="el" href="group__stdattrs.html#ga3fc601747b554b5f67e9e14a1a2a2e8d">onlp_asset_info_t</a> *rv)</td></tr>
|
|
<tr class="memdesc:gaacc08958c1915162b5b0e004cfb724a7"><td class="mdescLeft"> </td><td class="mdescRight">Get an OID's Asset attribute. <a href="#gaacc08958c1915162b5b0e004cfb724a7">More...</a><br /></td></tr>
|
|
<tr class="separator:gaacc08958c1915162b5b0e004cfb724a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gaacc08958c1915162b5b0e004cfb724a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaacc08958c1915162b5b0e004cfb724a7">◆ </a></span>onlp_attributei_asset_info_get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_attributei_asset_info_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__stdattrs.html#ga3fc601747b554b5f67e9e14a1a2a2e8d">onlp_asset_info_t</a> * </td>
|
|
<td class="paramname"><em>rv</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get an OID's Asset attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>The target OID. </td></tr>
|
|
<tr><td class="paramname">rv</td><td>[out] Receives the Asset information if supported. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>if rv is NULL you should only return whether the attribute is supported. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa1ff39f9833ecd101e98b2d6a7f3c81b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa1ff39f9833ecd101e98b2d6a7f3c81b">◆ </a></span>onlp_attributei_free()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_attributei_free </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attribute</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Free an attribute value returned from <a class="el" href="group__attributei.html#gaaecba73893c74bc1e994710bd4817b3e" title="Get an attribute from the given OID. ">onlp_attributei_get()</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>The OID. </td></tr>
|
|
<tr><td class="paramname">attribute</td><td>The attribute. </td></tr>
|
|
<tr><td class="paramname">value</td><td>The value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaaecba73893c74bc1e994710bd4817b3e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaaecba73893c74bc1e994710bd4817b3e">◆ </a></span>onlp_attributei_get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_attributei_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attribute</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void ** </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get an attribute from the given OID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">oid</td><td>The OID. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">attribute</td><td>The attribute to retrieve. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>Receives the attributei's value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab88e01ee2c3c443b071c063ed80bdd33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab88e01ee2c3c443b071c063ed80bdd33">◆ </a></span>onlp_attributei_onie_info_get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_attributei_onie_info_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">onlp_onie_info_t * </td>
|
|
<td class="paramname"><em>rv</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get an OID's ONIE attribute. </p>
|
|
<p>Access to standard attributes. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>The target OID </td></tr>
|
|
<tr><td class="paramname">rv</td><td>[out] Receives the ONIE information if supported. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>if rv is NULL you should only return whether the attribute is supported. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga31e4c462f109756375c7cf69b1139bba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga31e4c462f109756375c7cf69b1139bba">◆ </a></span>onlp_attributei_set()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_attributei_set </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attribute</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set an attribute on the given OID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>The OID. </td></tr>
|
|
<tr><td class="paramname">attribute</td><td>The attribute name. </td></tr>
|
|
<tr><td class="paramname">value</td><td>A pointer to the value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaabb6e25906d2ff17331ac7900cec62d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaabb6e25906d2ff17331ac7900cec62d9">◆ </a></span>onlp_attributei_supported()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_attributei_supported </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> </td>
|
|
<td class="paramname"><em>oid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>attribute</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determine whether the OID supports the given attributei. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oid</td><td>The OID. </td></tr>
|
|
<tr><td class="paramname">attribute</td><td>The attribute name. </td></tr>
|
|
</table>
|
|
</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|