Change the project's website to http://noping.cc/ everywhere.

[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 55c9ec9..07e7590 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,12 +49,12 @@ 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.
 


@@ -73,10 +73,25 @@ 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.
 
 buffer should be big enough to hold an integer value.
 

+=item B<PING_INFO_RECV_QOS>
+
+Returns the value of the I<Quality of Service> (QoS) byte of the incoming IPv4
+or IPv6 packet. This byte is not interpreted by I<liboping> at all and may be
+DSCPE<nbsp>/ ECN or precedenceE<nbsp>/ ToS depending on your network setup.
+Please see the appropriate RFCs for further information on values you can
+expect to receive. The buffer is expected to an C<uint8_t>.
+

 =back
 
 The I<buffer> argument is a pointer to an appropriately sized area of memory
 =back
 
 The I<buffer> argument is a pointer to an appropriately sized area of memory


@@ -96,6 +111,17 @@ If the requested information didn't fit into I<buffer> then the size that would
 have been needed is written into I<buffer_len>; I<buffer> itself is left
 untouched. The return value is B<ENOMEM> in this case.
 
 have been needed is written into I<buffer_len>; I<buffer> itself is left
 untouched. The return value is B<ENOMEM> in this case.
 

+=head1 KNOWN BUGS
+
+=over 4
+
+=item
+
+B<PING_INFO_RECV_TTL> is not available under Debian Etch due to a missing
+define in the header files.
+
+=back
+

 =head1 SEE ALSO
 
 L<ping_iterator_get(3)>,
 =head1 SEE ALSO
 
 L<ping_iterator_get(3)>,


@@ -103,7 +129,7 @@ L<liboping(3)>
 
 =head1 AUTHOR
 
 
 =head1 AUTHOR
 

-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>ff at octo.itE<gt>.
+Its homepage can be found at L<http://noping.cc/>.

 
 

-(c) 2005-2008 by Florian octo Forster.
+Copyright (c) 2005-2011 by Florian "octo" Forster.