156 lines
13 KiB
HTML
156 lines
13 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>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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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">PIP
|
|
 <span id="projectnumber">1.4.0</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></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">
|
|
<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:a11ad0ecf6a1d9c84fc54c30b10139b19"><td class="memItemLeft" align="right" valign="top"><a id="a11ad0ecf6a1d9c84fc54c30b10139b19"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a11ad0ecf6a1d9c84fc54c30b10139b19">isActive</a> () const</td></tr>
|
|
<tr class="memdesc:a11ad0ecf6a1d9c84fc54c30b10139b19"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is active. <br /></td></tr>
|
|
<tr class="separator:a11ad0ecf6a1d9c84fc54c30b10139b19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc0f65e14de629bbc7631b900171d997"><td class="memItemLeft" align="right" valign="top"><a id="adc0f65e14de629bbc7631b900171d997"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#adc0f65e14de629bbc7631b900171d997">isRunning</a> () const</td></tr>
|
|
<tr class="memdesc:adc0f65e14de629bbc7631b900171d997"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is running. <br /></td></tr>
|
|
<tr class="separator:adc0f65e14de629bbc7631b900171d997"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ca81f371384074601690d065f563058"><td class="memItemLeft" align="right" valign="top"><a id="a2ca81f371384074601690d065f563058"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a2ca81f371384074601690d065f563058">isBroadcast</a> () const</td></tr>
|
|
<tr class="memdesc:a2ca81f371384074601690d065f563058"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface support broadcast. <br /></td></tr>
|
|
<tr class="separator:a2ca81f371384074601690d065f563058"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f3be3b83f0ea728a5d8e2f841597261"><td class="memItemLeft" align="right" valign="top"><a id="a4f3be3b83f0ea728a5d8e2f841597261"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a4f3be3b83f0ea728a5d8e2f841597261">isMulticast</a> () const</td></tr>
|
|
<tr class="memdesc:a4f3be3b83f0ea728a5d8e2f841597261"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface support multicast. <br /></td></tr>
|
|
<tr class="separator:a4f3be3b83f0ea728a5d8e2f841597261"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af217e643d84ee78c3b1fd503b3803e90"><td class="memItemLeft" align="right" valign="top"><a id="af217e643d84ee78c3b1fd503b3803e90"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#af217e643d84ee78c3b1fd503b3803e90">isLoopback</a> () const</td></tr>
|
|
<tr class="memdesc:af217e643d84ee78c3b1fd503b3803e90"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is loopback. <br /></td></tr>
|
|
<tr class="separator:af217e643d84ee78c3b1fd503b3803e90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5135c0cc308456b036ca1fb45fbf7448"><td class="memItemLeft" align="right" valign="top"><a id="a5135c0cc308456b036ca1fb45fbf7448"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a5135c0cc308456b036ca1fb45fbf7448">isPTP</a> () const</td></tr>
|
|
<tr class="memdesc:a5135c0cc308456b036ca1fb45fbf7448"><td class="mdescLeft"> </td><td class="mdescRight">Returns if interface is point-to-point. <br /></td></tr>
|
|
<tr class="separator:a5135c0cc308456b036ca1fb45fbf7448"><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 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:a28f3bd135e33fd5660c3738f3e66ec5b"><td class="memItemLeft" align="right" valign="top"><a id="a28f3bd135e33fd5660c3738f3e66ec5b"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_i_ethernet_1_1_interface.html#a28f3bd135e33fd5660c3738f3e66ec5b">mtu</a></td></tr>
|
|
<tr class="memdesc:a28f3bd135e33fd5660c3738f3e66ec5b"><td class="mdescLeft"> </td><td class="mdescRight">MTU. <br /></td></tr>
|
|
<tr class="separator:a28f3bd135e33fd5660c3738f3e66ec5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9994b57e884e2ac345520f5743957a88"><td class="memItemLeft" align="right" valign="top"><a 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 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 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 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 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 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 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 Fri Dec 8 2017 16:36:05 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|