HH::Unispool::Config::File::Token::Numbered::System::3 - system type C<3> system I<S> token

HH-Unispool-Config documentation Contained in the HH-Unispool-Config distribution.

Index

Code Index:

NAME

Top

HH::Unispool::Config::File::Token::Numbered::System::3 - system type 3 system S token

SYNOPSIS

Top

Application programmers don't need to use this class and API programmers read code.

ABSTRACT

Top

system type 3 system S token

DESCRIPTION

Top

HH::Unispool::Config::File::Token::Numbered::System::3 contans system type 3 system S token information.

CONSTRUCTOR

Top

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::File::Token::Numbered::System::3 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 inherited through package HH::Unispool::Config::File::Token may include:

input_line_number

Passed to set_input_line_number().

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

number

Passed to set_number().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token::Numbered::System may include:

acct

Passed to set_acct().

apass

Passed to set_apass().

block_delay

Passed to set_block_delay().

execution_priority

Passed to set_execution_priority().

high_priority_login

Passed to set_high_priority_login().

initially_open

Passed to set_initially_open().

remote_system_name

Passed to set_remote_system_name(). Mandatory option.

timeout

Passed to set_timeout().

upass

Passed to set_upass().

new_from_string(LINE)

Creates a new object from the specified Unispool config file line string.

METHODS

Top

get_acct()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the remote login account (is not available on development system used).

get_apass()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the account password (is not available on development system used).

get_block_delay()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the time in seconds UNISPOOL should pause between sending two blocks.

get_execution_priority()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the execution priority of the driver process on MPE hosts.

get_input_line_number()

This method is inherited from package HH::Unispool::Config::File::Token. Returns the line number from from which the token is read.

get_number()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered. Returns the number of the entry.

get_remote_system_name()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the unique name for the remote system.

get_timeout()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the delay before closing the link after transfering the last request (in seconds) (is not available on development system used).

get_upass()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns the user paccword (is not available on development system used).

is_high_priority_login()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns whether the login must be high priotity (is not available on development system used) or not.

is_initially_open()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Returns whether the communication link should be opened at the moment UNISPOOL is started or not.

read_string(LINE)

This method is overloaded from package HH::Unispool::Config::File::Token::Numbered::System. Reads the Unispool config file token from a line string. LINE is a plain line string. On error an exception Error::Simple is thrown.

set_acct(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the remote login account (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

set_apass(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the account password (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

set_block_delay(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the time in seconds UNISPOOL should pause between sending two blocks. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_execution_priority(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the execution priority of the driver process on MPE hosts. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:

HH::Unispool::Config::ExecPri

set_high_priority_login(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. State that the login must be high priotity (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

set_initially_open(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. State that the communication link should be opened at the moment UNISPOOL is started. VALUE is the value. On error an exception Error::Simple is thrown.

set_input_line_number(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token. Set the line number from from which the token is read. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_number(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered. Set the number of the entry. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_remote_system_name(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the unique name for the remote system. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.+$

set_timeout(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the delay before closing the link after transfering the last request (in seconds) (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_upass(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered::System. Set the user paccword (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

write_string()

This method is overloaded from package HH::Unispool::Config::File::Token::Numbered::System. Returns a Unispool config file token line string.

SEE ALSO

Top

HH::Unispool::Config, HH::Unispool::Config::DateFormat, HH::Unispool::Config::Entry, HH::Unispool::Config::Entry::Device, HH::Unispool::Config::Entry::Device::0, HH::Unispool::Config::Entry::Device::1, HH::Unispool::Config::Entry::Device::2, HH::Unispool::Config::Entry::Device::3, HH::Unispool::Config::Entry::Device::4, HH::Unispool::Config::Entry::Device::5, HH::Unispool::Config::Entry::Device::6, HH::Unispool::Config::Entry::Device::7, HH::Unispool::Config::Entry::Filter, HH::Unispool::Config::Entry::Numbered, HH::Unispool::Config::Entry::RemoteSystem, HH::Unispool::Config::Entry::RemoteSystem::3, HH::Unispool::Config::Entry::RemoteSystem::6, HH::Unispool::Config::Entry::RemoteSystem::7, HH::Unispool::Config::Entry::RemoteSystem::8, HH::Unispool::Config::Entry::System, HH::Unispool::Config::ExecPri, HH::Unispool::Config::File::Token, HH::Unispool::Config::File::Token::Comment, HH::Unispool::Config::File::Token::Comment::Cs, HH::Unispool::Config::File::Token::Comment::Date, HH::Unispool::Config::File::Token::Comment::Device, HH::Unispool::Config::File::Token::Comment::Filter, HH::Unispool::Config::File::Token::Comment::Group, HH::Unispool::Config::File::Token::Comment::Head, HH::Unispool::Config::File::Token::Comment::Misc, HH::Unispool::Config::File::Token::Comment::NetDesc, HH::Unispool::Config::File::Token::Comment::RSys, HH::Unispool::Config::File::Token::Comment::Scope, HH::Unispool::Config::File::Token::Comment::Tail, HH::Unispool::Config::File::Token::Factory, HH::Unispool::Config::File::Token::Numbered, HH::Unispool::Config::File::Token::Numbered::Device, HH::Unispool::Config::File::Token::Numbered::Device::0, HH::Unispool::Config::File::Token::Numbered::Device::1, HH::Unispool::Config::File::Token::Numbered::Device::2, HH::Unispool::Config::File::Token::Numbered::Device::3, HH::Unispool::Config::File::Token::Numbered::Device::4, HH::Unispool::Config::File::Token::Numbered::Device::5, HH::Unispool::Config::File::Token::Numbered::Device::6, HH::Unispool::Config::File::Token::Numbered::Device::7, HH::Unispool::Config::File::Token::Numbered::Device::Group, HH::Unispool::Config::File::Token::Numbered::Device::Info, HH::Unispool::Config::File::Token::Numbered::Device::P, HH::Unispool::Config::File::Token::Numbered::Network, HH::Unispool::Config::File::Token::Numbered::System, HH::Unispool::Config::File::Token::Numbered::System::6, HH::Unispool::Config::File::Token::Numbered::System::7, HH::Unispool::Config::File::Token::Numbered::System::8, HH::Unispool::Config::File::Token::Numbered::System::Info, HH::Unispool::Config::File::Token::Numbered::X, HH::Unispool::Config::File::Token::Unnumbered, HH::Unispool::Config::File::Token::Unnumbered::Bcs, HH::Unispool::Config::File::Token::Unnumbered::CSN, HH::Unispool::Config::File::Token::Unnumbered::Cs, HH::Unispool::Config::File::Token::Unnumbered::CsBcs, HH::Unispool::Config::File::Token::Unnumbered::Filter, HH::Unispool::Config::File::Token::Unnumbered::Host, HH::Unispool::Config::File::Token::Unnumbered::Misc, HH::Unispool::Config::File::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope

BUGS

Top

None known (yet.)

HISTORY

Top

First development: February 2003 Last update: September 2003

AUTHOR

Top

Vincenzo Zocca

COPYRIGHT

Top

Copyright 2003 by Vincenzo Zocca

LICENSE

Top

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

HH-Unispool-Config documentation Contained in the HH-Unispool-Config distribution. 
package HH::Unispool::Config::File::Token::Numbered::System::3;

use 5.006;
use base qw( HH::Unispool::Config::File::Token::Numbered::System );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);
use HH::Unispool::Config::File::Token qw( :rx :frm );

# Package version
our ($VERSION) = '$Revision: 0.3 $' =~ /\$Revision:\s+([^\s]+)/;

1;

__END__


sub read_string {
    my $self = shift;
    my $line = shift;

    # Parse line for name
    my ($number, $remote_system_name, $tail) = $line =~ /$USP_S3_RX/;
    defined($number) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::3::read_string, parameter 'LINE' does not match the regular expression for this token's line string.");
    $remote_system_name =~ s/\s*$//;
    my @tail = $self->_split_tail($tail);
    my $acct = $tail[0];
    my $apass = $tail[1];
    my $upass = $tail[2];
    my $timeout = $tail[4];
    my $flags = $tail[7];
    my $exec = $tail[8];

    # Set attributes
    $self->set_number($number);
    defined($remote_system_name) && $self->set_remote_system_name($remote_system_name);
    defined($acct) && $self->set_acct($acct);
    defined($apass) && $self->set_apass($apass);
    defined($upass) && $self->set_upass($upass);
    defined($timeout) && $self->set_timeout($timeout);
    defined($flags) && $self->set_initially_open( $flags =~ /i/i );
    defined($flags) && $self->set_high_priority_login( $flags =~ /h/i );
    require HH::Unispool::Config::ExecPri;
    defined($exec) && $self->set_execution_priority( HH::Unispool::Config::ExecPri->new( {execution_priority=> $exec} ) );
}

sub write_string {
    my $self = shift;

    # Make string and return it
    my $flags = '';
    $flags .= $self->is_high_priority_login() ? 'H' : ' ';
    $flags .= $self->is_initially_open() ? 'I' : ' ';
    return(
        sprintf(
            $USP_S3_FRM,
            $self->get_number() || 0,
            $self->get_remote_system_name() || '',
            $self->get_acct() || '',
            $self->get_apass() || '',
            $self->get_upass() || '',
            $self->get_timeout() || 0,
            $flags || '',
            $self->get_execution_priority()->get_execution_priority() || '',
        )
    );
}