NAME

HH::Unispool::Config::Entry::Device::6 - UNISPOOL type 6 device

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::Device::6;

# 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 6 device to _Local_
my $dev = HH::Unispool::Config::Entry::Device::6->new( {
    name => 'lp',
    filter_name => 'cat',
    remote_node_name => 'lp.foo.bar.org',
    description => 'lp',
} );
$sysn->add_device($dev);

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

ABSTRACT

UNISPOOL type 6 device

DESCRIPTION

Class HH::Unispool::Config::Entry::Device::6 holds information for UNISPOOL type 6 device

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::Entry::Device::6 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.
connect_retry: Passed to set_connect_retry(). Defaults to 0.
device_password: Passed to set_device_password().
execution_priority: Passed to set_execution_priority(). Defaults to HH::Unispool::Config::ExecPri->new( { execution_priority = '' } )>.
header_name: Passed to set_header_name().
initially_spooled: Passed to set_initially_spooled(). Defaults to 1.
networkwide: Passed to set_networkwide(). Defaults to 1.
profile_name: Passed to set_profile_name().
protocol: Passed to set_protocol(). Defaults to 'TCP'.
remote_node_name: Passed to set_remote_node_name(). Mandatory option.
save_printfile: Passed to set_save_printfile(). Defaults to 0.
server_tcp_port: Passed to set_server_tcp_port(). Defaults to 9100.
trailer_name: Passed to set_trailer_name().

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::Device may include:

description: Passed to set_description().
filter_name: Passed to set_filter_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().

new_from_tokenizer(TOKENIZER)

This method is an implementation from package 'HH::Unispool::Config::Entry::Device'. 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::Device'. 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::Device'. 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_connect_retry(VALUE)

Set the number of seconds UNISPOOL should wait if the connection can not be established immediately. 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_connect_retry()

Returns the number of seconds UNISPOOL should wait if the connection can not be established immediately.

set_device_password(VALUE)

Set the password required to access the device. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

get_device_password()

Returns the password required to access the device.

set_execution_priority(VALUE)

Set the execution priority of the driver process on MPE hosts. VALUE is the value. Default value at initialization is HH::Unispool::Config::ExecPri->new( { execution_priority = '' } )>. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:

HH::Unispool::Config::ExecPri

get_execution_priority()

Returns the execution priority of the driver process on MPE hosts.

set_header_name(VALUE)

Set the control procedure to be executed before printing the printfile. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

get_header_name()

Returns the control procedure to be executed before printing the printfile.

set_initially_spooled(VALUE)

State that an automatic STARTSPOOL must be performed when UNISPOOL is started. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

is_initially_spooled()

Returns whether an automatic STARTSPOOL must be performed when UNISPOOL is started or not.

set_networkwide(VALUE)

State that the device must be made available from each node in the configuration cluster. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

is_networkwide()

Returns whether the device must be made available from each node in the configuration cluster or not.

set_profile_name(VALUE)

Set the name of the profile containing the device initialisation and status checking specification. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

get_profile_name()

Returns the name of the profile containing the device initialisation and status checking specification.

set_protocol(VALUE)

Set the protocol to be used for the device. VALUE is the value. Default value at initialization is 'TCP'. On error an exception Error::Simple is thrown.

VALUE must be a one of:

LPD
PJL
TCP
XPP

get_protocol()

Returns the protocol to be used for the device.

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:

^.+$

get_remote_node_name()

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

set_save_printfile(VALUE)

State that printfiles printed on this device should be saved. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

is_save_printfile()

Returns whether printfiles printed on this device should be saved or not.

set_server_tcp_port(VALUE)

Set the TCP port assigned on the print server. VALUE is the value. Default value at initialization is 9100. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

get_server_tcp_port()

Returns the TCP port assigned on the print server.

set_trailer_name(VALUE)

Set the control procedure to be executed after printing the printfile. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

get_trailer_name()

Returns the control procedure to be executed after printing the printfile.

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

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

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

To access attribute named description:: set_description(), get_description()
To access attribute named filter_name:: set_filter_name(), get_filter_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()

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::Device

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

SEE ALSO

BUGS

HISTORY

AUTHOR

COPYRIGHT

LICENSE

Module Install Instructions