Steve Roscio > Tk-DoCommand > Tk::DoCommand

Download:
Tk-DoCommand-0.1.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.1   Source  

NAME ^

Tk::DoCommand - Asynchronously Do a Command

SYNOPSIS ^

    use Tk;
    use Tk::DoCommand;

    my $mw = new MainWindow;
    my $dc = $mw->DoCommand(-command => "ls -al")->pack;
    $dc->start_command;     # Run the command, returns immediately
        .
        .
        .
    if ($dc->is_done) { ... }       # Test if command is finished
    my $pid = $dc->get_pid;         # Get the pid of the command's process
    my @status = $dc->get_status;   # Returns ($?, $!) from command
    my $text = $dc_>get_output;     # Result text from command
    $dc->kill_command;              # Rudely terminate the command
    $dc->wait;                      # Wait for command to finish (blocks)

DESCRIPTION ^

Execute a command asynchronously, and display the output within this widget. Both stdout and stderr are captured.

This is-a Tk::ROText widget.

This is similar to Tk::ExecuteCommand. But Tk::ExecuteCommand is not fully asynchronous, it that its execute_command() function is blocking. Also, Tk::ExecuteCommand has "fluff" around it (buttons, text). This widget is bare-bones; it's just an ROText widget.

The following options/value pairs are supported:

-command

Command to execute.

METHODS ^

start_command

Execute the command. The command is run in a background pipe; this function returns immediately.

get_status

Returns a 2 element array of $? and $! from last command execution.

get_output

A convienence method to return the result text from the command. This is the same as calling ->get('1.0' => 'end -1 chars'), since this widget is derived from an ROText widget.

is_done

Tests if the command has finished executing.

kill_command

Terminates the command. This is called automatically via an OnDestroy handler when the DoCommand widget goes away.

pid

Returns the process id of the process that's executing the command.

wait

Wait for the command to complete. Obviously, this is a blocking call.

ADVERTISED SUBWIDGETS ^

None.

AUTHOR ^

Steve Roscio <roscio@cpan.org>

Copyright (c) 2010, Steve Roscio <roscio@cpan.org>. All rights reserved.

Code liberally mooched from Tk::ExecuteCommand by Stephen O. Lidie. Thanx Steve!

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

Because this software is licensed free of charge, there is no warranty for the software, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the software "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the software is with you. Should the software prove defective, you assume the cost of all necessary servicing, repair, or correction.

In no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who may modify and/or redistribute the software as permitted by the above licence, be liable to you for damages, including any general, special, incidental, or consequential damages arising out of the use or inability to use the software (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the software to operate with any other software), even if such holder or other party has been advised of the possibility of such damages.

KEYWORDS ^

DoCommand

syntax highlighting: