File: Poco.Net.ICMPEventArgs.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 (113 lines) | stat: -rw-r--r-- 7,468 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
102
103
104
105
106
107
108
109
110
111
112
113
<!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::ICMPEventArgs</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 ICMPEventArgs</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> ICMP<br />
<b>Header:</b> Poco/Net/ICMPEventArgs.h</p>
<h2>Description</h2>
<div class="description">
<p>The purpose of the <a href="Poco.Net.ICMPEventArgs.html" title="class Poco::Net::ICMPEventArgs">ICMPEventArgs</a> class is to be used as template parameter to instantiate event members in <a href="Poco.Net.ICMPClient.html" title="class Poco::Net::ICMPClient">ICMPClient</a> class. When clients register for an event notification, the reference to the class is  passed to the handler function to provide information about the event. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.ICMPEventArgs.html#13382" title="Poco::Net::ICMPEventArgs::avgRTT()">avgRTT</a>, <a href="Poco.Net.ICMPEventArgs.html#13372" title="Poco::Net::ICMPEventArgs::dataSize()">dataSize</a>, <a href="Poco.Net.ICMPEventArgs.html#13378" title="Poco::Net::ICMPEventArgs::error()">error</a>, <a href="Poco.Net.ICMPEventArgs.html#13370" title="Poco::Net::ICMPEventArgs::hostAddress()">hostAddress</a>, <a href="Poco.Net.ICMPEventArgs.html#13369" title="Poco::Net::ICMPEventArgs::hostName()">hostName</a>, <a href="Poco.Net.ICMPEventArgs.html#13381" title="Poco::Net::ICMPEventArgs::maxRTT()">maxRTT</a>, <a href="Poco.Net.ICMPEventArgs.html#13380" title="Poco::Net::ICMPEventArgs::minRTT()">minRTT</a>, <a href="Poco.Net.ICMPEventArgs.html#13383" title="Poco::Net::ICMPEventArgs::percent()">percent</a>, <a href="Poco.Net.ICMPEventArgs.html#13375" title="Poco::Net::ICMPEventArgs::received()">received</a>, <a href="Poco.Net.ICMPEventArgs.html#13371" title="Poco::Net::ICMPEventArgs::repetitions()">repetitions</a>, <a href="Poco.Net.ICMPEventArgs.html#13376" title="Poco::Net::ICMPEventArgs::replyTime()">replyTime</a>, <a href="Poco.Net.ICMPEventArgs.html#13374" title="Poco::Net::ICMPEventArgs::sent()">sent</a>, <a href="Poco.Net.ICMPEventArgs.html#13373" title="Poco::Net::ICMPEventArgs::ttl()">ttl</a></p>
<h2>Constructors</h2>
<h3><a name="13363">ICMPEventArgs</a></h3>
<p class="decl"><a href="Poco.Net.ICMPEventArgs.html" title="class Poco::Net::ICMPEventArgs">ICMPEventArgs</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> &amp; address,<br />&nbsp;&nbsp;&nbsp;&nbsp;int repetitions,<br />&nbsp;&nbsp;&nbsp;&nbsp;int dataSize,<br />&nbsp;&nbsp;&nbsp;&nbsp;int ttl<br />);</p>
<div class="description">
<p>Creates <a href="Poco.Net.ICMPEventArgs.html" title="class Poco::Net::ICMPEventArgs">ICMPEventArgs</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="13368">~ICMPEventArgs</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.Net.ICMPEventArgs.html" title="class Poco::Net::ICMPEventArgs">ICMPEventArgs</a>();</p>
<div class="description">
<p>Destroys <a href="Poco.Net.ICMPEventArgs.html" title="class Poco::Net::ICMPEventArgs">ICMPEventArgs</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="13382">avgRTT</a></h3>
<p class="decl">int avgRTT() const;</p>
<div class="description">
<p>Returns the average round trip time for a sequence of requests. </p>
</div>
<h3><a name="13372">dataSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int dataSize() const;</p>
<div class="description">
<p>Returns the packet data size in bytes. </p>
</div>
<h3><a name="13378">error</a></h3>
<p class="decl">const std::string &amp; error(<br />&nbsp;&nbsp;&nbsp;&nbsp;int index = - 1<br />) const;</p>
<div class="description">
<p>Returns the error string for the request specified with index. If index == -1 (default), returns the most recent error string. </p>
</div>
<h3><a name="13370">hostAddress</a></h3>
<p class="decl">std::string hostAddress() const;</p>
<div class="description">
<p>Returns the target IP address. </p>
</div>
<h3><a name="13369">hostName</a></h3>
<p class="decl">std::string hostName() const;</p>
<div class="description">
<p>Tries to resolve the target IP address into host name. If unsuccessful, all exceptions are silently ignored and  the IP address is returned. </p>
</div>
<h3><a name="13381">maxRTT</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int maxRTT() const;</p>
<div class="description">
<p>Returns the maximum round trip time for a sequence of requests. </p>
</div>
<h3><a name="13380">minRTT</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int minRTT() const;</p>
<div class="description">
<p>Returns the minimum round trip time for a sequence of requests. </p>
</div>
<h3><a name="13383">percent</a></h3>
<p class="decl">float percent() const;</p>
<div class="description">
<p>Returns the success percentage for a sequence of requests. </p>
</div>
<h3><a name="13375">received</a></h3>
<p class="decl">int received() const;</p>
<div class="description">
<p>Returns the number of packets received. </p>
</div>
<h3><a name="13371">repetitions</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int repetitions() const;</p>
<div class="description">
<p>Returns the number of repetitions for the ping operation. </p>
</div>
<h3><a name="13376">replyTime</a></h3>
<p class="decl">int replyTime(<br />&nbsp;&nbsp;&nbsp;&nbsp;int index = - 1<br />) const;</p>
<div class="description">
<p>Returns the reply time for the request specified with index. If index == -1 (default), returns the most recent reply time. </p>
</div>
<h3><a name="13374">sent</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int sent() const;</p>
<div class="description">
<p>Returns the number of packets sent. </p>
</div>
<h3><a name="13373">ttl</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int ttl() const;</p>
<div class="description">
<p>Returns time to live. </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>