blob: 015180fb73fd38303a0efe6531e57b67c2b015f8 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libguac: guacamole/wol-constants.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libguac<span id="projectnumber">&#160;1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">wol-constants.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Header file that provides constants and defaults related to libguac Wake-on-LAN support.
<a href="#details">More...</a></p>
<p><a href="wol-constants_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 id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8a3ab3403bd4e7295bcc59f9edbcc35f"><td class="memItemLeft" align="right" valign="top"><a id="a8a3ab3403bd4e7295bcc59f9edbcc35f" name="a8a3ab3403bd4e7295bcc59f9edbcc35f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GUAC_WOL_LOCAL_IPV4_BROADCAST</b>&#160;&#160;&#160;&quot;255.255.255.255&quot;</td></tr>
<tr class="memdesc:a8a3ab3403bd4e7295bcc59f9edbcc35f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value for the local IPv4 broadcast address. <br /></td></tr>
<tr class="separator:a8a3ab3403bd4e7295bcc59f9edbcc35f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93bd13de95bbdc785737ac23ad965f54"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="wol-constants_8h.html#a93bd13de95bbdc785737ac23ad965f54">GUAC_WOL_PACKET_SIZE</a>&#160;&#160;&#160;102</td></tr>
<tr class="memdesc:a93bd13de95bbdc785737ac23ad965f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the magic Wake-on-LAN packet to send to wake a remote host. <br /></td></tr>
<tr class="separator:a93bd13de95bbdc785737ac23ad965f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fd19bb639955ecb864cc6d25de4f41b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="wol-constants_8h.html#a7fd19bb639955ecb864cc6d25de4f41b">GUAC_WOL_PORT</a>&#160;&#160;&#160;9</td></tr>
<tr class="memdesc:a7fd19bb639955ecb864cc6d25de4f41b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The port number that the magic packet should contain as the destination. <br /></td></tr>
<tr class="separator:a7fd19bb639955ecb864cc6d25de4f41b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header file that provides constants and defaults related to libguac Wake-on-LAN support. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a93bd13de95bbdc785737ac23ad965f54" name="a93bd13de95bbdc785737ac23ad965f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93bd13de95bbdc785737ac23ad965f54">&#9670;&#160;</a></span>GUAC_WOL_PACKET_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUAC_WOL_PACKET_SIZE&#160;&#160;&#160;102</td>
</tr>
</table>
</div><div class="memdoc">
<p>The size of the magic Wake-on-LAN packet to send to wake a remote host. </p>
<p>This consists of 6 bytes of 0xFF, and then the MAC address repeated 16 times. <a href="https://en.wikipedia.org/wiki/Wake-on-LAN#Magic_packet">https://en.wikipedia.org/wiki/Wake-on-LAN#Magic_packet</a> </p>
</div>
</div>
<a id="a7fd19bb639955ecb864cc6d25de4f41b" name="a7fd19bb639955ecb864cc6d25de4f41b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fd19bb639955ecb864cc6d25de4f41b">&#9670;&#160;</a></span>GUAC_WOL_PORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUAC_WOL_PORT&#160;&#160;&#160;9</td>
</tr>
</table>
</div><div class="memdoc">
<p>The port number that the magic packet should contain as the destination. </p>
<p>In reality this doesn't matter all that much, since the packet is not usually processed by a full IP stack, but defining one is considered a standard practice. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>