.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::OpenSSH::ConnectionCache 3"
.TH Net::OpenSSH::ConnectionCache 3 2023-10-09 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::OpenSSH::ConnectionCache \- cache and reuse SSH connections transparently
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Net::OpenSSH;
\&  use Net::OpenSSH::ConnectionCache;
\&
\&  for (1..10) {
\&    my $ssh = Net::OpenSSH\->new($host);
\&    $ssh\->system("$cmd $_");
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module installs a \f(CW$Net::OpenSSH::FACTORY\fR hook implementing a
SSH connection caching scheme.
.PP
\&\f(CW$Net::OpenSSH::ConnectionCache::MAX_SIZE\fR controls the cache
size. Once as many connections are allocated, the module will try to
free any of them before allocating a new one.
.PP
The function \f(CW\*(C`clean_cache\*(C'\fR makes the module forget (and close) all
the cached connections:
.PP
.Vb 1
\&  Net::OpenSSH::ConnectionCache::clean_cache();
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2011, 2014 by Salvador Fandiño
(sfandino@yahoo.com)
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.0 or,
at your option, any later version of Perl 5 you may have available.