Asuro/doc/icmp.html

147 lines
8.2 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>Asuro: icmp</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.15.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Asuro</h2><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p><p><a href="GVUses.png" class="navigation">Unit dependency graph</a></p><form class="search-form" action="_tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input"></div><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></form>
<div style="clear: both"></div>
<script type="text/javascript">
$(document).ready(function() {
$('#tipue_search_input').tipuesearch({
/* 10 items to display seems standard */
'show': 10,
/* For PasDoc docs, showing urls is not very useful,
since the page title already shows the unit and identifier. */
'showURL': false
});
});
</script>
</td><td class="content">
<h1 class="unit">Unit icmp</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Uses">Uses</a></div><div class="one_section"><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></div><div class="one_section"><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></div><div class="one_section"><a class="section" href="#PasDoc-Types">Types</a></div><div class="one_section">Constants</div><div class="one_section">Variables</div></div>
<span id="PasDoc-Description"></span><h2 class="description">Description</h2>
<p>
Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L4-&gt;<code>ICMP</code> - Internet Control Message Protocol Driver,
<p></p>
<span id="PasDoc-Uses"></span><h2 class="uses">Uses</h2>
<ul class="useslist"><li><a href="bios_data_area.html">bios_data_area</a></li><li><a href="lmemorymanager.html">lmemorymanager</a></li><li><a href="net.html">net</a></li><li><a href="nettypes.html">nettypes</a></li><li><a href="netutils.html">netutils</a></li><li><a href="ipv4.html">ipv4</a></li><li><a href="console.html">console</a></li><li><a href="terminal.html">terminal</a></li><li><a href="arp.html">arp</a></li><li><a href="util.html">util</a></li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Classes"></span><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Record&nbsp;<a class="bold" href="icmp.TARPHandler.html"><code>TARPHandler</code></a></td>
<td class="itemdesc">&nbsp;</td>
</tr>
</table>
<span id="PasDoc-FuncsProcs"></span><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="icmp.html#register">register</a></b>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="icmp.html#sendICMPRequest">sendICMPRequest</a></b>(ip : <a href="system.html#PuInt8">puint8</a>; Sequence : <a href="system.html#uInt16">uint16</a>; TTL : <a href="system.html#uInt8">uint8</a>; OnRep : <a href="icmp.html#TARPReplyCallback">TARPReplyCallback</a>; OnErr : <a href="icmp.html#TARPErrorCallback">TARPErrorCallback</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="icmp.html#ping_err">ping_err</a></b>(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>; Reason : <a href="icmp.html#TARPErrorCode">TARPErrorCode</a>);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="icmp.html#ping_rep">ping_rep</a></b>(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>);</code></td>
</tr>
</table>
<span id="PasDoc-Types"></span><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="icmp.html#TARPErrorCode">TARPErrorCode</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="icmp.html#TARPReplyCallback">TARPReplyCallback</a></b> = procedure(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="icmp.html#TARPErrorCallback">TARPErrorCallback</a></b> = procedure(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>; Reason : <a href="icmp.html#TARPErrorCode">TARPErrorCode</a>);</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="register"></span><code>procedure <b>register</b>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="sendICMPRequest"></span><code>procedure <b>sendICMPRequest</b>(ip : <a href="system.html#PuInt8">puint8</a>; Sequence : <a href="system.html#uInt16">uint16</a>; TTL : <a href="system.html#uInt8">uint8</a>; OnRep : <a href="icmp.html#TARPReplyCallback">TARPReplyCallback</a>; OnErr : <a href="icmp.html#TARPErrorCallback">TARPErrorCallback</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="ping_err"></span><code>procedure <b>ping_err</b>(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>; Reason : <a href="icmp.html#TARPErrorCode">TARPErrorCode</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="ping_rep"></span><code>procedure <b>ping_rep</b>(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="TARPErrorCode"></span><code><b>TARPErrorCode</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;<h6 class="description_section">Values</h6>
<ul>
<li>
<span id="aecFailedToResolveHost">aecFailedToResolveHost</span></li>
<li>
<span id="aecNoRouteToHost">aecNoRouteToHost</span></li>
<li>
<span id="aecTimeout">aecTimeout</span></li>
<li>
<span id="aecTTLExpired">aecTTLExpired</span></li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="TARPReplyCallback"></span><code><b>TARPReplyCallback</b> = procedure(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="TARPErrorCallback"></span><code><b>TARPErrorCallback</b> = procedure(hdr : <a href="nettypes.html#PICMPHeader">PICMPHeader</a>; Reason : <a href="icmp.html#TARPErrorCode">TARPErrorCode</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<h2 class="authors">Author</h2>
<ul class="authors">
<li>Kieron Morris &lt;<a href="mailto:kjm@kieronmorris.me">kjm@kieronmorris.me</a>&gt;</li>
</ul>
<hr><span class="appinfo"><em>Generated by <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
</span>
</td></tr></table></body></html>