NAME

HH::Unispool::Config::Entry::RemoteSystem::8 - UNISPOOL type 8 remote system

SYNOPSIS

use strict;

use HH::Unispool::Config;
use HH::Unispool::Config::OS;
use HH::Unispool::Config::Scope;
use HH::Unispool::Config::Entry::System;
use HH::Unispool::Config::Entry::RemoteSystem::8;

# Create a config from scratch with a _Local_ scope
my $conf = HH::Unispool::Config->new( {
    scope => HH::Unispool::Config::Scope->new ( {
        scope => [ qw( _Local_) ],
    } ),
} );

# Create the _Local_ system and add it to the configuration
my $sysn = HH::Unispool::Config::Entry::System->new( {
    name => '_Local_',
    local_system_name => 'foo',
    network_name => 'foo.bar.org',
    os => HH::Unispool::Config::OS->new( {
        os => 'Solaris',
    } ),
} );
$conf->add_system($sysn);

# Add a type 8 remote system to _Local_
my $dev = HH::Unispool::Config::Entry::RemoteSystem::8->new( {
    name => 'rsys8',
    remote_node_name => 'barney.bedrock.org',
    os => HH::Unispool::Config::OS->new( {
        os => 'Solaris',
    } ),
} );
$sysn->add_remote_system($dev);

# Write the configuration
$conf->write('t/config.sample.r8.out');

ABSTRACT

UNISPOOL type 8 remote system

DESCRIPTION

Class HH::Unispool::Config::Entry::RemoteSystem::8 holds information for UNISPOOL type 8 remote systems

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::Entry::RemoteSystem::8 object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

block_delay: Passed to set_block_delay(). Defaults to 0.
initially_open: Passed to set_initially_open(). Defaults to 1.
os: Passed to set_os(). Mandatory option.
remote_node_name: Passed to set_remote_node_name(). Mandatory option.
transfer_size: Passed to set_transfer_size(). Defaults to 4098.
transfer_time_out: Passed to set_transfer_time_out(). Defaults to 180.

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::Entry may include:

name: Passed to set_name(). Mandatory option.

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::Entry::Numbered may include:

diff_number: Passed to set_diff_number(). Defaults to 0.
number: Passed to set_number().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::Entry::RemoteSystem may include:

description: Passed to set_description().
execution_priority: Passed to set_execution_priority(). Defaults to HH::Unispool::Config::ExecPri->new( { execution_priority = '' } )>.

new_from_tokenizer(TOKENIZER)

This method is an implementation from package 'HH::Unispool::Config::Entry::RemoteSystem'. Constructs a new HH::Unispool::Config::Entry object using tokens. TOKENIZER is an HH::Unispool::Config::File::Tokenizer reference. On error an exception Error::Simple is thrown.

METHODS

diff(TO [, DIFF_NUMBER])

This method is an implementation from package 'HH::Unispool::Config::Entry::RemoteSystem'. Finds differences between two objects. In diff terms, the object is the from object and the specified TO parameter the to object. TO is a reference to an identical object class. Returns an empty string if no difference found and a difference descritpion string otherwise. On error an exception Error::Simple is thrown. Paremeter DIFF_NUMBER if specified, overrules the value of get_diff_number.

write(FILE_HANDLE)

This method is an implementation from package 'HH::Unispool::Config::Entry::RemoteSystem'. Writes the entry to the specified file handle. FILE_HANDLE is an IO::Handle reference. On error an exception Error::Simple is thrown.

set_block_delay(VALUE)

Set the time in seconds UNISPOOL should pause between sending two blocks. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

get_block_delay()

Returns the time in seconds UNISPOOL should pause between sending two blocks.

set_initially_open(VALUE)

State that the communication link should be opened at the moment UNISPOOL is started. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

is_initially_open()

Returns whether the communication link should be opened at the moment UNISPOOL is started or not.

set_os(VALUE)

Set the operating system running on the remote node. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:

HH::Unispool::Config::OS

get_os()

Returns the operating system running on the remote node.

set_remote_node_name(VALUE)

Set the name of the system as it can be resolved by the network software. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^[\w\.]+$

get_remote_node_name()

Returns the name of the system as it can be resolved by the network software.

set_transfer_size(VALUE)

Set the size of the data blocks to be transfered. VALUE is the value. Default value at initialization is 4098. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

get_transfer_size()

Returns the size of the data blocks to be transfered.

set_transfer_time_out(VALUE)

Set the time in which a transfer must be completed to be considered successful. VALUE is the value. Default value at initialization is 180. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

get_transfer_time_out()

Returns the time in which a transfer must be completed to be considered successful.

INHERITED METHODS FROM HH::Unispool::Config::Entry

To access attribute named name:: set_name(), get_name()

INHERITED METHODS FROM HH::Unispool::Config::Entry::Numbered

To access attribute named diff_number:: set_diff_number(), is_diff_number()
To access attribute named number:: set_number(), get_number()

INHERITED METHODS FROM HH::Unispool::Config::Entry::RemoteSystem

To access attribute named description:: set_description(), get_description()
To access attribute named execution_priority:: set_execution_priority(), get_execution_priority()

BUGS

None known (yet.)

HISTORY

First development: February 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

LICENSE

This file is part of the HH::Unispool::Config module hierarchy for Perl by Vincenzo Zocca.

The HH::Unispool::Config module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The HH::Unispool::Config module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the HH::Unispool::Config module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

To install HH::Unispool::Config, copy and paste the appropriate command in to your terminal.

cpanm

cpanm HH::Unispool::Config

CPAN shell

perl -MCPAN -e shell
install HH::Unispool::Config

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

ABSTRACT

DESCRIPTION

CONSTRUCTOR

METHODS

INHERITED METHODS FROM HH::Unispool::Config::Entry

INHERITED METHODS FROM HH::Unispool::Config::Entry::Numbered

INHERITED METHODS FROM HH::Unispool::Config::Entry::RemoteSystem

SEE ALSO

BUGS

HISTORY

AUTHOR

COPYRIGHT

LICENSE

Module Install Instructions