slackget10::Operation - Abstraction of an operation
Version 0.5
A class to represent an operation (installation, upgrade, etc.). Mainly designed to make operations management in the GUI simplier.
## This is a dumb example...
use slackget10::Operation;
my $op = slackget10::Operation->new(
action => 'installpkg'
data => $package_list, # $package_list is a slackget10::PackageList object
);
$net->installpkg( $op->data() );
new() : The constructor take the followings arguments :
id : an operation id. If the ID is not set by you, the constructor use the class reference as ID and it's not suitable at all.
action : the name of the operation, this name must be understood by the method which will process this operation (obviously...).
data : data that belongs to the operation.
Commonly the operation's action will be the name of a method from the slackget10::Network class.
If the method receiving this object just call the appropriate method of a specific class you just have to read the documentation of this class and put in the data section the right data.
Get/Set the data payload of the current slackget10::Operation object.
Get/Set the action of the current slackget10::Operation object.
$op->action('installpkg');
Get/Set the id of the current slackget10::Operation object. The ID usage is up to the receiving class, but in all case you must
print $op->id();
Get/Set the QListViewItem object reference (for GUI only). This accessor is provided to help the design of the GUI.
Get/Set the processing state of this operation. This state can be updated by the "thing" which process the operation, this way the current state is accessible to all object who can access this method.
You can use any data type you want to represent the state, but if you develop a plug-in or anything else for slack-get the following states are used :
0 : operation is in queue, waiting for being processed.
1 : operation processing in progress (in the GUI during this state an operation is locked and not accessible)
2 : operation successfully processed.
3: an error occur during operation's processing.
4: operation cancelled
This list can be completed if needed.
$op->state(2);
print "operation cancelled\n" if ( $op->state == 4 ) ;
Get/Set the callback eventually executed (if defined) at a state modification of this object. Valid state (for slack-get) are the state listed in the the state() method.
# Setting a callback which don't take any arguments
$op->state_callback(2,\&my_success_hook) ;
# Setting a callback which take some arguments
$op->state_callback(3,\&my_error_hook,$message,$dump) ;
# Calling a callback method
$op->state_callback(2);
DUPUIS Arnaud, <a.dupuis@infinityperl.org>
Please report any bugs or feature requests to bug-slackget10@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=slackget10. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc slackget10
You can also look for information at:
Thanks to Bertrand Dupuis (yes my brother) for his contribution to the documentation.
Copyright 2005 DUPUIS Arnaud, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
