From: octo Date: Mon, 1 May 2006 16:27:47 +0000 (+0000) Subject: Moved `liboping.pod' from `src/' to `src/mans/' X-Git-Tag: liboping-0.1.0~15 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=da7bb68eab479ccf6fd605b7850ae6cb05735c18;p=collectd.git Moved `liboping.pod' from `src/' to `src/mans/' --- diff --git a/src/liboping.pod b/src/liboping.pod deleted file mode 100644 index a6d46beb..00000000 --- a/src/liboping.pod +++ /dev/null @@ -1,86 +0,0 @@ -=head1 NAME - -liboping - Library to send ICMPv4/ICMPv6 echo packets to multiple hosts - -=head1 DESCRIPTION - -This is an overview of liboping, a C library to send ICMP ECHO_REQUEST packets -to remote hosts and measure the time it takes for replies to be received. This -method, often simply called "ping", is a common way to measure network latency -and/or host reachability. - -The goals of this library are to provide the above functionality in a platform -and protocol independent manner. The interface is simple, object oriented and -(hopefully) ANSI-C compliant. - -=head1 GENERAL USAGE - -There are two main types that are used by applications. Both are "opaque -types", meaning they are structures that are B completely defined in the -header file, so you cannot access the structures' members. You don't need to, -don't do it. These structures are object to change without notice. - -=over 4 - -=item C - -A ping-object. You can set specific options for this object, add and remove -hosts to/from it and send ICMP packets to all associated hosts. This is often -called a "handle". - -=item C - -An iterator over the hosts associated with a C object. This iterator -can be used to query more information about a host, for example the hostname, -the measured latency or the current ICMP sequence. - -=back - -Upon startup you usually create one or more C objects and add hosts -to it using the C method (see below). You periodically send -"echo requests" using the C method, iterate over all hosts using -C and C. For each host you call -C to read the current latency and do something with it. - -If an error occurs you can use C so get information on what -failed. - -=head1 LINKING WITH LIBOPING - -Depending on you platform you don't need any extra libraries (e.g. GNU/Linux) -or C (using C<-lsocket>) if the C function is not in the -C-library. The latter is the case for the Solaris operating system. - -=head1 SYMBOL NAMES - -All "official" function or method names are prefixed with "ping_". Don't use -any other functions or methods. Although no such functions should exist. - -=head1 THREAD SAFETY - -liboping has been designed to be as thread safe a possible. However, this has -not been tested and may need some additional work. Use at your own risk and -please report back any problems or success messages. Thank you :) - -=head1 SEE ALSO - -ping_construct(3), -ping_setopt(3), -ping_host_add(3), -ping_send(3), -ping_get_error(3), -ping_iterator_get(3), -ping_iterator_get_info(3), -ping_iterator_get_context(3) - -=head1 LICENSE - -liboping is licensed under the GPLv2. No other version of the license is -applicable. - -=head1 CONTACT / AUTHOR - -liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. - -(c) 2005, 2006 by Florian octo Forster. diff --git a/src/mans/liboping.pod b/src/mans/liboping.pod new file mode 100644 index 00000000..a6d46beb --- /dev/null +++ b/src/mans/liboping.pod @@ -0,0 +1,86 @@ +=head1 NAME + +liboping - Library to send ICMPv4/ICMPv6 echo packets to multiple hosts + +=head1 DESCRIPTION + +This is an overview of liboping, a C library to send ICMP ECHO_REQUEST packets +to remote hosts and measure the time it takes for replies to be received. This +method, often simply called "ping", is a common way to measure network latency +and/or host reachability. + +The goals of this library are to provide the above functionality in a platform +and protocol independent manner. The interface is simple, object oriented and +(hopefully) ANSI-C compliant. + +=head1 GENERAL USAGE + +There are two main types that are used by applications. Both are "opaque +types", meaning they are structures that are B completely defined in the +header file, so you cannot access the structures' members. You don't need to, +don't do it. These structures are object to change without notice. + +=over 4 + +=item C + +A ping-object. You can set specific options for this object, add and remove +hosts to/from it and send ICMP packets to all associated hosts. This is often +called a "handle". + +=item C + +An iterator over the hosts associated with a C object. This iterator +can be used to query more information about a host, for example the hostname, +the measured latency or the current ICMP sequence. + +=back + +Upon startup you usually create one or more C objects and add hosts +to it using the C method (see below). You periodically send +"echo requests" using the C method, iterate over all hosts using +C and C. For each host you call +C to read the current latency and do something with it. + +If an error occurs you can use C so get information on what +failed. + +=head1 LINKING WITH LIBOPING + +Depending on you platform you don't need any extra libraries (e.g. GNU/Linux) +or C (using C<-lsocket>) if the C function is not in the +C-library. The latter is the case for the Solaris operating system. + +=head1 SYMBOL NAMES + +All "official" function or method names are prefixed with "ping_". Don't use +any other functions or methods. Although no such functions should exist. + +=head1 THREAD SAFETY + +liboping has been designed to be as thread safe a possible. However, this has +not been tested and may need some additional work. Use at your own risk and +please report back any problems or success messages. Thank you :) + +=head1 SEE ALSO + +ping_construct(3), +ping_setopt(3), +ping_host_add(3), +ping_send(3), +ping_get_error(3), +ping_iterator_get(3), +ping_iterator_get_info(3), +ping_iterator_get_context(3) + +=head1 LICENSE + +liboping is licensed under the GPLv2. No other version of the license is +applicable. + +=head1 CONTACT / AUTHOR + +liboping is written by Florian octo Forster Eocto at verplant.orgE. +It's homepage can be found at L. + +(c) 2005, 2006 by Florian octo Forster.