/ 
XAS-0.15
River stage one • 6 direct dependents • 6 total dependents
1 ++
/ XAS::Lib::Batch

NAME

XAS::Lib::Batch - A class for the XAS environment

SYNOPSIS

 use XAS::Class
   version => '0.01',
   base    => 'XAS::Lib::Batch'
 ;

DESCRIPTION

This is a class for accessing a batch system. Batch systems are a controlled way to run jobs in the background. Depending on how the batch system is setup you may have access to hundreds of systems to run jobs on. These jobs can then controlled by issuing commads against the batch system. This module encapsulates those commands into Perl objects and methods.

There is apparently a standardized command line interface to these batch systems. This module also helps to abstract some of the differences between those standardized commands. Because if you work in this business long enough you get to know what "standardized" really means.

Since this is Perl and you are loading a mixin. You could access the mixin methods directly. But it is advisable to use the pre-defined classes to help with parameter checking and exception handling.

METHODS

new

This initializes the class and takes these parameters:

-interface

This defines the interface to load. It defaults to XAS::Lib::Batch::Interface::Torque.

do_cmd($command)

This method will run a command and capture its output. If an non zero return code is detected, it will throw an exception with that return code and the first output line returned.

$command

The command to execute in the background using Perl's backtick function. STDERR is redirected into STDOUT.

SEE ALSO

XAS::Lib::Batch::Job
XAS::Lib::Batch::Queue
XAS::Lib::Batch::Server
XAS::Lib::Batch::Interface::Torque
XAS

AUTHOR

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE

Copyright (c) 2012-2015 Kevin L. Esteb

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0. For details, see the full text of the license at http://www.perlfoundation.org/artistic_license_2_0.