package perfSONAR_PS::Collectors::LinkStatus::Agent::Constant;

=head1 NAME

perfSONAR_PS::Collectors::LinkStatus::Agent::Constant - This module provides an
agent for the Link Status Collector that simply returns a constant value.

=head1 DESCRIPTION

When run, this agent will simply return the constant value its been configured
to return along with the machine's current time.

=head1 API
=cut


use strict;
use warnings;

our $VERSION = 0.09;

use fields 'TYPE', 'CONSTANT';

=head2 new ($self, $status_type, $constant)
    Creates a new Constant Agent of the specified type and with the specified
    constant value.
=cut
sub new {
    my ($class, $type, $constant) = @_;

    my $self = fields::new($class);

    $self->{"TYPE"} = $type;
    $self->{"CONSTANT"} = $constant;

    return $self;
}

=head2 getType
    Returns the status type of this agent: admin or oper.
=cut
sub getType {
    my ($self) = @_;

    return $self->{TYPE};
}

=head2 setType ($self, $type)
    Sets the status type of this agent: admin or oper.
=cut
sub setType {
    my ($self, $type) = @_;

    $self->{TYPE} = $type;

    return;
}

=head2 setConstant ($self, $constant)
    Sets the constant value to be returned.
=cut
sub setConstant {
    my ($self, $constant) = @_;

    $self->{CONSTANT} = $constant;

    return;
}

=head2 getConstant ($self)
    Returns the constant value.
=cut
sub getConstant {
    my ($self) = @_;

    return $self->{CONSTANT};
}

=head2 run ($self)
    Returns the constant value that's been configured along with the current
    time of the machine its being run on.
=cut
sub run {
    my ($self) = @_;

    my $time = time;

    if (not defined $self->{CONSTANT} or $self->{CONSTANT} eq "") {
        my $msg = "no constant defined";
        return (-1, $msg);
    }

    return (0, $time, $self->{CONSTANT});
}

1;

__END__

To join the 'perfSONAR-PS' mailing list, please visit:

https://mail.internet2.edu/wws/info/i2-perfsonar

The perfSONAR-PS subversion repository is located at:

https://svn.internet2.edu/svn/perfSONAR-PS

Questions and comments can be directed to the author, or the mailing list.  Bugs,
feature requests, and improvements can be directed here:

https://bugs.internet2.edu/jira/browse/PSPS

=head1 VERSION

$Id:$

=head1 AUTHOR

Aaron Brown, aaron@internet2.edu

=head1 LICENSE

You should have received a copy of the Internet2 Intellectual Property Framework along
with this software.  If not, see <http://www.internet2.edu/membership/ip.html>

=head1 COPYRIGHT

Copyright (c) 2004-2008, Internet2 and the University of Delaware

All rights reserved.

=cut
# vim: expandtab shiftwidth=4 tabstop=4