Commit | Line | Data |
a0d0e21e |
1 | =head1 NAME |
2 | |
3 | Net::Ping, pingecho - check a host for upness |
4 | |
5 | =head1 SYNOPSIS |
6 | |
7 | use Net::Ping; |
8 | print "'jimmy' is alive and kicking\n" if pingecho('jimmy', 10) ; |
9 | |
10 | =head1 DESCRIPTION |
11 | |
12 | This module contains routines to test for the reachability of remote hosts. |
13 | Currently the only routine implemented is pingecho(). |
14 | |
748a9306 |
15 | pingecho() uses a TCP echo (I<not> an ICMP one) to determine if the |
a0d0e21e |
16 | remote host is reachable. This is usually adequate to tell that a remote |
17 | host is available to rsh(1), ftp(1), or telnet(1) onto. |
18 | |
19 | =head2 Parameters |
20 | |
21 | =over 5 |
22 | |
23 | =item hostname |
24 | |
25 | The remote host to check, specified either as a hostname or as an IP address. |
26 | |
27 | =item timeout |
28 | |
29 | The timeout in seconds. If not specified it will default to 5 seconds. |
30 | |
31 | =back |
32 | |
33 | =head1 WARNING |
34 | |
35 | pingecho() uses alarm to implement the timeout, so don't set another alarm |
36 | while you are using it. |
37 | |