Minor documentation fixes.

[liboping.git] / src / mans / ping_iterator_get_info.pod

diff --git a/src/mans/ping_iterator_get_info.pod b/src/mans/ping_iterator_get_info.pod
index 57322bb..d7ee565 100644 (file)
--- a/src/mans/ping_iterator_get_info.pod
+++ b/src/mans/ping_iterator_get_info.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
 =head1 NAME
 

-ping_iterator_get_info - Constructor for the liboping class
+ping_iterator_get_info - Receive information about a host

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -35,7 +35,7 @@ to C<ping_host_remove>, too.
 Return the hostname of the host the iterator points to. Since the name is
 looked up using the socket address this may differ from the hostname passed to
 L<ping_host_add(3)>. The hostname is actually looked up every time you call
 Return the hostname of the host the iterator points to. Since the name is
 looked up using the socket address this may differ from the hostname passed to
 L<ping_host_add(3)>. The hostname is actually looked up every time you call

-this method, no cache is involved within liboping.
+this method, no cache is involved within I<liboping>.

 
 It is recommended to include C<netdb.h> and allocate B<NI_MAXHOST> bytes of
 buffer.
 
 It is recommended to include C<netdb.h> and allocate B<NI_MAXHOST> bytes of
 buffer.


@@ -49,15 +49,22 @@ won't hurt.
 
 =item B<PING_INFO_FAMILY>
 
 
 =item B<PING_INFO_FAMILY>
 

-Returns the address family of the host. The buffer should be ig enough to hold
+Returns the address family of the host. The buffer should be big enough to hold

 an integer. The value is either B<AF_INET> or B<AF_INET6>.
 
 =item B<PING_INFO_LATENCY>
 
 an integer. The value is either B<AF_INET> or B<AF_INET6>.
 
 =item B<PING_INFO_LATENCY>
 

-Return the last measured latency or less than zero if the timeout occured
+Return the last measured latency or less than zero if the timeout occurred

 before a echo response was received. The buffer should be big enough to hold a
 double value.
 
 before a echo response was received. The buffer should be big enough to hold a
 double value.
 

+=item B<PING_INFO_DROPPED>
+
+Return the number of times that no response was received within the timeout.
+This value is only increased but may wrap around at the 32E<nbsp>bit boundary.
+The buffer should be big enough to hold a 32E<nbsp>bit integer, e.E<nbsp>g. an
+C<uint32_t>.
+

 =item B<PING_INFO_SEQUENCE>
 
 Return the last sequence number sent. This number is increased regardless of
 =item B<PING_INFO_SEQUENCE>
 
 Return the last sequence number sent. This number is increased regardless of


@@ -66,8 +73,15 @@ echo responses being received or not. The buffer should hold an integer.
 =item B<PING_INFO_IDENT>
 
 Return the ident that is put into every ICMP packet sent to this host. Per
 =item B<PING_INFO_IDENT>
 
 Return the ident that is put into every ICMP packet sent to this host. Per

-convention this usually is the PID of the sending process, but since liboping
-can handle several hosts in parallel it uses a (pseudo-)random number here. The
+convention this usually is the PID of the sending process, but since
+I<liboping> can handle several hosts in parallel it uses a (pseudo-)random
+number here. The buffer should be big enough to hold an integer value.
+
+=item B<PING_INFO_RECV_TTL>
+
+Returns the I<time to live> (TTL) of the received network packets. This number
+depends on the value that was used by the remote host when it sent the echo
+reply and has nothing to do with the B<PING_OPT_TTL> of L<ping_setopt(3)>. The

 buffer should be big enough to hold an integer value.
 
 =back
 buffer should be big enough to hold an integer value.
 
 =back


@@ -99,4 +113,4 @@ L<liboping(3)>
 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
 It's homepage can be found at L<http://verplant.org/liboping/>.
 
 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
 It's homepage can be found at L<http://verplant.org/liboping/>.
 

-(c) 2005-2008 by Florian octo Forster.
+(c) 2005-2009 by Florian octo Forster.