File: Poco.Net.ICMPPacket.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (101 lines) | stat: -rw-r--r-- 6,222 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<!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>
<title>Class Poco::Net::ICMPPacket</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Net.html" class="namespace">Poco::Net</a></h1>
<h1 class="symbol">class ICMPPacket</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> ICMP<br />
<b>Header:</b> Poco/Net/ICMPPacket.h</p>
<h2>Description</h2>
<div class="description">
<p>This class is the ICMP packet abstraction.  </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.ICMPPacket.html#13424" title="Poco::Net::ICMPPacket::errorDescription()">errorDescription</a>, <a href="Poco.Net.ICMPPacket.html#13416" title="Poco::Net::ICMPPacket::getDataSize()">getDataSize</a>, <a href="Poco.Net.ICMPPacket.html#13417" title="Poco::Net::ICMPPacket::maxPacketSize()">maxPacketSize</a>, <a href="Poco.Net.ICMPPacket.html#13411" title="Poco::Net::ICMPPacket::packet()">packet</a>, <a href="Poco.Net.ICMPPacket.html#13412" title="Poco::Net::ICMPPacket::packetSize()">packetSize</a>, <a href="Poco.Net.ICMPPacket.html#13413" title="Poco::Net::ICMPPacket::sequence()">sequence</a>, <a href="Poco.Net.ICMPPacket.html#13414" title="Poco::Net::ICMPPacket::setDataSize()">setDataSize</a>, <a href="Poco.Net.ICMPPacket.html#13418" title="Poco::Net::ICMPPacket::time()">time</a>, <a href="Poco.Net.ICMPPacket.html#13427" title="Poco::Net::ICMPPacket::typeDescription()">typeDescription</a>, <a href="Poco.Net.ICMPPacket.html#13421" title="Poco::Net::ICMPPacket::validReplyID()">validReplyID</a></p>
<h2>Constructors</h2>
<h3><a name="13407">ICMPPacket</a></h3>
<p class="decl"><a href="Poco.Net.ICMPPacket.html" title="class Poco::Net::ICMPPacket">ICMPPacket</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Net.IPAddress.html#13594" title="enum  Poco::Net::IPAddress::Family">IPAddress::Family</a> family,<br />&nbsp;&nbsp;&nbsp;&nbsp;int dataSize = 48<br />);</p>
<div class="description">
<p>Creates an <a href="Poco.Net.ICMPPacket.html" title="class Poco::Net::ICMPPacket">ICMPPacket</a> of specified family. </p>
</div>
<h2>Destructor</h2>
<h3><a name="13410">~ICMPPacket</a></h3>
<p class="decl">~<a href="Poco.Net.ICMPPacket.html" title="class Poco::Net::ICMPPacket">ICMPPacket</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.ICMPPacket.html" title="class Poco::Net::ICMPPacket">ICMPPacket</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="13424">errorDescription</a></h3>
<p class="decl">std::string errorDescription(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11350" title="Poco::UInt8">Poco::UInt8</a> * buffer,<br />&nbsp;&nbsp;&nbsp;&nbsp;int length<br />);</p>
<div class="description">
<p>Returns error description string. If supplied buffer contains an ICMP echo reply packet, an empty string is returned indicating the absence of error. </p>
<p>Supplied buffer includes IP header, ICMP header and data. </p>
</div>
<h3><a name="13416">getDataSize</a></h3>
<p class="decl">int getDataSize() const;</p>
<div class="description">
<p>Returns data size. </p>
</div>
<h3><a name="13417">maxPacketSize</a></h3>
<p class="decl">int maxPacketSize() const;</p>
<div class="description">
<p>Returns the total length of packet (header + data); </p>
</div>
<h3><a name="13411">packet</a></h3>
<p class="decl">const <a href="Poco.html#11350" title="Poco::UInt8">Poco::UInt8</a> * packet();</p>
<div class="description">
<p>Returns raw ICMP packet. ICMP header and data are included in the returned packet. </p>
</div>
<h3><a name="13412">packetSize</a></h3>
<p class="decl">int packetSize() const;</p>
<div class="description">
<p>Returns the total length of packet (header + data); </p>
</div>
<h3><a name="13413">sequence</a></h3>
<p class="decl"><a href="Poco.html#11352" title="Poco::UInt16">Poco::UInt16</a> sequence() const;</p>
<div class="description">
<p>Returns the most recent sequence number generated. </p>
</div>
<h3><a name="13414">setDataSize</a></h3>
<p class="decl">void setDataSize(<br />&nbsp;&nbsp;&nbsp;&nbsp;int dataSize<br />);</p>
<div class="description">
<p>Sets data size. </p>
</div>
<h3><a name="13418">time</a></h3>
<p class="decl">struct timeval time(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11350" title="Poco::UInt8">Poco::UInt8</a> * buffer = 0,<br />&nbsp;&nbsp;&nbsp;&nbsp;int length = 0<br />) const;</p>
<div class="description">
<p>Returns current epoch time if either buffer or length are equal to zero. Otherwise, it extracts the time value from the supplied buffer and  returns the extracted value. </p>
<p>Supplied buffer includes IP header, ICMP header and data. </p>
</div>
<h3><a name="13427">typeDescription</a></h3>
<p class="decl">std::string typeDescription(<br />&nbsp;&nbsp;&nbsp;&nbsp;int typeId<br />);</p>
<div class="description">
<p>Returns the description of the packet type. </p>
</div>
<h3><a name="13421">validReplyID</a></h3>
<p class="decl">bool validReplyID(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11350" title="Poco::UInt8">Poco::UInt8</a> * buffer,<br />&nbsp;&nbsp;&nbsp;&nbsp;int length<br />) const;</p>
<div class="description">
<p>Returns true if the extracted id is recognized  (equals the process id). </p>
<p>Supplied buffer includes IP header, ICMP header and data. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>