Code

ping_iterator_get_info(3): Document the "PING_INFO_RECV_QOS" flag.
authorFlorian Forster <octo@verplant.org>
Wed, 27 Oct 2010 13:40:06 +0000 (15:40 +0200)
committerFlorian Forster <octo@verplant.org>
Wed, 27 Oct 2010 13:40:06 +0000 (15:40 +0200)
src/mans/ping_iterator_get_info.pod

index 23e123e6975d1ab5f6c84d583c0a48511ccf3c95..744a552f887b6a683d77633ba1806c0c12dbd741 100644 (file)
@@ -84,6 +84,14 @@ 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.
 
+=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