/usr/share/perl5/FCM/Context/Task.pm is in fcm 2016.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | # ------------------------------------------------------------------------------
# (C) British Crown Copyright 2006-16 Met Office.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM 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 3 of the License, or
# (at your option) any later version.
#
# FCM 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 FCM. If not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------------------
use strict;
use warnings;
# ------------------------------------------------------------------------------
package FCM::Context::Task;
use base qw{FCM::Class::HASH};
use constant {
ST_FAILED => 'ST_FAILED',
ST_OK => 'ST_OK',
ST_WORKING => 'ST_WORKING',
};
__PACKAGE__->class({
ctx => {},
error => {},
id => '$',
elapse => {isa => '$', default => 0},
state => {isa => '$', default => ST_WORKING},
});
# ------------------------------------------------------------------------------
1;
__END__
=head1 NAME
FCM::Context::Task
=head1 SYNOPSIS
use FCM::Context::Task;
my $task = FCM::Context::Task->new(\%attrib);
=head1 DESCRIPTION
An instance of this class represents the generic context for a task for the
L<FCM::Util->task_runner()|FCM::Util>. This class is a sub-class of
L<FCM::Class::HASH|FCM::Class::HASH>.
=head1 ATTRIBUTES
=over 4
=item ctx
The specific context of the task, such as the inputs and the outputs.
=item error
If the task failed, the error/exception will be returned in this attribute.
=item id
The ID of the task.
=item elapse
The amount of time (in seconds) taken to run the task.
=item state
The state of the task. See L</CONSTANTS> for possible variables.
=back
=head1 CONSTANTS
=over 4
=item FCM::Context::Task->ST_FAILED
A status to indicate that the task has failed.
=item FCM::Context::Task->ST_OK
A status to indicate that the task is completed successfully.
=item FCM::Context::Task->ST_WORKING
A status to indicate that the task is bing worked on.
=back
=head1 COPYRIGHT
(C) Crown copyright Met Office. All rights reserved.
=cut
|