Difference between revisions of "Esmith::util::link"
From SME Server
Jump to navigationJump to search (Created page with "=== NAME === esmith::util::link - utilities for manipulating network links === SYNOPSIS === use esmith::util::link qw(getExternalLink); # wait at mo...") |
(→NAME) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=== NAME === | === NAME === | ||
esmith::util::link - utilities for manipulating network links | esmith::util::link - utilities for manipulating network links | ||
| + | |||
| + | see perldoc esmith::util::link | ||
=== SYNOPSIS === | === SYNOPSIS === | ||
| Line 26: | Line 28: | ||
==== Functions ==== | ==== Functions ==== | ||
getExternalLink($timeout) | getExternalLink($timeout) | ||
| − | Bring up the external link if it is not already up, waiting at most $timeout seconds. If a $timeout is not specified, it defaults to 300 (5 minutes) for dialup connections. | + | Bring up the external link if it is not already up, waiting at most $timeout seconds. If a $timeout is not specified, it defaults to 300 (5 minutes) for dialup connections. |
| + | This function can be used for both dialup and dedicated connections, but dedicated connections will always return 1 (true). | ||
Returns 1 if the external link is already up, or if it comes up within the specfied $timeout period. | Returns 1 if the external link is already up, or if it comes up within the specfied $timeout period. | ||
Latest revision as of 13:34, 19 June 2015
NAME
esmith::util::link - utilities for manipulating network links
see perldoc esmith::util::link
SYNOPSIS
use esmith::util::link qw(getExternalLink);
# wait at most 60 seconds for the link to come up
my $timeout = 60;
# now just get the link
if (getExternalLink($timeout))
{
# the link is up
}
else
{
# the link didn't come up
}
DESCRIPTION
This is a collection of generally useful functions for manipulating network links.
Functions are exported only on request.
Functions
getExternalLink($timeout)
Bring up the external link if it is not already up, waiting at most $timeout seconds. If a $timeout is not specified, it defaults to 300 (5 minutes) for dialup connections. This function can be used for both dialup and dedicated connections, but dedicated connections will always return 1 (true).
Returns 1 if the external link is already up, or if it comes up within the specfied $timeout period.
Returns 0 if the external link does not come up within the specified $timeout period.
perl v5.10.1 2003-09-02 esmith::util::link(3)
