NAME

HH::Unispool::Config::File::Token::Numbered::Device - abstract class for device D tokens

SYNOPSIS

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

ABSTRACT

abstract class for device D tokens

DESCRIPTION

HH::Unispool::Config::File::Token::Numbered::Device is an abstract class for device D tokens.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::File::Token::Numbered::Device 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().
buffer_size: Passed to set_buffer_size().
connect_retry: Passed to set_connect_retry().
device_name: Passed to set_device_name(). Mandatory option.
device_password: Passed to set_device_password().
execution_priority: Passed to set_execution_priority().
initially_spooled: Passed to set_initially_spooled().
networkwide: Passed to set_networkwide().
page_length: Passed to set_page_length().
page_width: Passed to set_page_width().
remote_device_name: Passed to set_remote_device_name().
remote_system_name: Passed to set_remote_system_name().
save_printfile: Passed to set_save_printfile().
unispool_control: Passed to set_unispool_control().
unispool_header: Passed to set_unispool_header().

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().

new_from_string(LINE)

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

METHODS

get_block_delay()

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

get_buffer_size()

Returns the number of bytes sent to the printer in one write operation.

get_connect_retry()

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

get_device_name()

Returns the unique name for the device.

get_device_password()

Returns the password required to access the device.

get_execution_priority()

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_page_length()

Returns the page length (lines) for determining the size of UNISPOOL banners.

get_page_width()

Returns the page width (bytes) for determining the size of UNISPOOL banners.

get_remote_device_name()

Returns the device on the remote system that will receive the output.

get_remote_system_name()

Returns the name of the system to which the output for this device must be routed.

is_initially_spooled()

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

is_networkwide()

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

is_save_printfile()

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

is_unispool_control()

Returns whether the UNISPOOL control is on (is not available on development system used) or not.

is_unispool_header()

Returns whether standard UNISPOOL banners pages are printed initially or not.

read_string(LINE)

This method is overloaded from package HH::Unispool::Config::File::Token::Numbered. 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_block_delay(VALUE)

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_buffer_size(VALUE)

Set the number of bytes sent to the printer in one write operation. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_connect_retry(VALUE)

Set the number of seconds UNISPOOL should wait if the connection can not be established immediately. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_device_name(VALUE)

Set the unique name for the device. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.+$

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:

^.*$

set_execution_priority(VALUE)

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_initially_spooled(VALUE)

State that an automatic STARTSPOOL must be performed when 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_networkwide(VALUE)

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

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_page_length(VALUE)

Set the page length (lines) for determining the size of UNISPOOL banners. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_page_width(VALUE)

Set the page width (bytes) for determining the size of UNISPOOL banners. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d*$

set_remote_device_name(VALUE)

Set the device on the remote system that will receive the output. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

set_remote_system_name(VALUE)

Set the name of the system to which the output for this device must be routed. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.*$

set_save_printfile(VALUE)

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

set_unispool_control(VALUE)

State that the UNISPOOL control is on (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

set_unispool_header(VALUE)

State that standard UNISPOOL banners pages are printed initially. VALUE is the value. On error an exception Error::Simple is thrown.

write_string()

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

BUGS

None known (yet.)

HISTORY

First development: February 2003 Last update: September 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

SEE ALSO

BUGS

HISTORY

AUTHOR

COPYRIGHT

LICENSE

Module Install Instructions