198 lines
16 KiB
HTML
198 lines
16 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.8"/>
|
|
<title>PIP: PIEthernet::Interface Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">PIP
|
|
 <span id="projectnumber">0.4.1_alpha3</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.8 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('struct_p_i_ethernet_1_1_interface.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="struct_p_i_ethernet_1_1_interface-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PIEthernet::Interface Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Network interface descriptor.
|
|
<a href="struct_p_i_ethernet_1_1_interface.html#details">More...</a></p>
|
|
<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:ab76d86b68f0da23428ea8ecee802354a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab76d86b68f0da23428ea8ecee802354a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#ab76d86b68f0da23428ea8ecee802354a">isActive</a> () const </td></tr>
|
|
<tr class="memdesc:ab76d86b68f0da23428ea8ecee802354a"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is active. <br /></td></tr>
|
|
<tr class="separator:ab76d86b68f0da23428ea8ecee802354a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f603624bc1046421bdc75b25e6f1e78"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f603624bc1046421bdc75b25e6f1e78"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a5f603624bc1046421bdc75b25e6f1e78">isRunning</a> () const </td></tr>
|
|
<tr class="memdesc:a5f603624bc1046421bdc75b25e6f1e78"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is running. <br /></td></tr>
|
|
<tr class="separator:a5f603624bc1046421bdc75b25e6f1e78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af331db850efe21a7793bbf813f71c0b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af331db850efe21a7793bbf813f71c0b4"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#af331db850efe21a7793bbf813f71c0b4">isBroadcast</a> () const </td></tr>
|
|
<tr class="memdesc:af331db850efe21a7793bbf813f71c0b4"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface support broadcast. <br /></td></tr>
|
|
<tr class="separator:af331db850efe21a7793bbf813f71c0b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbfab446dc998e260231b2e7b90f5b29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbfab446dc998e260231b2e7b90f5b29"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#adbfab446dc998e260231b2e7b90f5b29">isMulticast</a> () const </td></tr>
|
|
<tr class="memdesc:adbfab446dc998e260231b2e7b90f5b29"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface support multicast. <br /></td></tr>
|
|
<tr class="separator:adbfab446dc998e260231b2e7b90f5b29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a469b2d721c49354fe43117cf75950920"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a469b2d721c49354fe43117cf75950920"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a469b2d721c49354fe43117cf75950920">isLoopback</a> () const </td></tr>
|
|
<tr class="memdesc:a469b2d721c49354fe43117cf75950920"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is loopback. <br /></td></tr>
|
|
<tr class="separator:a469b2d721c49354fe43117cf75950920"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04ba0d64139f4dc46561a4a4962edbf8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04ba0d64139f4dc46561a4a4962edbf8"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a04ba0d64139f4dc46561a4a4962edbf8">isPTP</a> () const </td></tr>
|
|
<tr class="memdesc:a04ba0d64139f4dc46561a4a4962edbf8"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is point-to-point. <br /></td></tr>
|
|
<tr class="separator:a04ba0d64139f4dc46561a4a4962edbf8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:adabd5e847a09e6d81e5a4f7f8a33d6cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adabd5e847a09e6d81e5a4f7f8a33d6cc"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#adabd5e847a09e6d81e5a4f7f8a33d6cc">index</a></td></tr>
|
|
<tr class="memdesc:adabd5e847a09e6d81e5a4f7f8a33d6cc"><td class="mdescLeft"> </td><td class="mdescRight">System index. <br /></td></tr>
|
|
<tr class="separator:adabd5e847a09e6d81e5a4f7f8a33d6cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9994b57e884e2ac345520f5743957a88"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9994b57e884e2ac345520f5743957a88"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a9994b57e884e2ac345520f5743957a88">name</a></td></tr>
|
|
<tr class="memdesc:a9994b57e884e2ac345520f5743957a88"><td class="mdescLeft"> </td><td class="mdescRight">System name. <br /></td></tr>
|
|
<tr class="separator:a9994b57e884e2ac345520f5743957a88"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a115e97cf7fb6306138c722fdf0d0d711"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a115e97cf7fb6306138c722fdf0d0d711"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a115e97cf7fb6306138c722fdf0d0d711">mac</a></td></tr>
|
|
<tr class="memdesc:a115e97cf7fb6306138c722fdf0d0d711"><td class="mdescLeft"> </td><td class="mdescRight">MAC address in format "hh:hh:hh:hh:hh:hh" or empty if there is no MAC address. <br /></td></tr>
|
|
<tr class="separator:a115e97cf7fb6306138c722fdf0d0d711"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa753498f5a63938b9218b3ccbd8a01bc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa753498f5a63938b9218b3ccbd8a01bc"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#aa753498f5a63938b9218b3ccbd8a01bc">address</a></td></tr>
|
|
<tr class="memdesc:aa753498f5a63938b9218b3ccbd8a01bc"><td class="mdescLeft"> </td><td class="mdescRight">IP address in format "i.i.i.i" or empty if there is no IP address. <br /></td></tr>
|
|
<tr class="separator:aa753498f5a63938b9218b3ccbd8a01bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac20887e6c3e2052f67f057d85d99fca6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac20887e6c3e2052f67f057d85d99fca6"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#ac20887e6c3e2052f67f057d85d99fca6">netmask</a></td></tr>
|
|
<tr class="memdesc:ac20887e6c3e2052f67f057d85d99fca6"><td class="mdescLeft"> </td><td class="mdescRight">Netmask of IP address in format "i.i.i.i" or empty if there is no netmask. <br /></td></tr>
|
|
<tr class="separator:ac20887e6c3e2052f67f057d85d99fca6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a840af238c8f0ec3216b7978d4a896ef8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a840af238c8f0ec3216b7978d4a896ef8"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a840af238c8f0ec3216b7978d4a896ef8">broadcast</a></td></tr>
|
|
<tr class="memdesc:a840af238c8f0ec3216b7978d4a896ef8"><td class="mdescLeft"> </td><td class="mdescRight">Broadcast address in format "i.i.i.i" or empty if there is no broadcast address. <br /></td></tr>
|
|
<tr class="separator:a840af238c8f0ec3216b7978d4a896ef8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7255bb721c0f03b4465eefa422e984da"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7255bb721c0f03b4465eefa422e984da"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a7255bb721c0f03b4465eefa422e984da">ptp</a></td></tr>
|
|
<tr class="memdesc:a7255bb721c0f03b4465eefa422e984da"><td class="mdescLeft"> </td><td class="mdescRight">Point-to-point address or empty if there is no point-to-point address. <br /></td></tr>
|
|
<tr class="separator:a7255bb721c0f03b4465eefa422e984da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a327b42e5652b8dfd680a3eddec948237"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a327b42e5652b8dfd680a3eddec948237"></a>
|
|
<a class="el" href="class_p_i_ethernet.html#a26d086cc06bc533006ac4fca2c3bab33">InterfaceFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a327b42e5652b8dfd680a3eddec948237">flags</a></td></tr>
|
|
<tr class="memdesc:a327b42e5652b8dfd680a3eddec948237"><td class="mdescLeft"> </td><td class="mdescRight">Flags of interface. <br /></td></tr>
|
|
<tr class="separator:a327b42e5652b8dfd680a3eddec948237"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Network interface descriptor. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_p_i_ethernet.html">PIEthernet</a></li><li class="navelem"><a class="el" href="struct_p_i_ethernet_1_1_interface.html">Interface</a></li>
|
|
<li class="footer">Generated on Sun Nov 2 2014 22:29:35 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|