NAME

perfSONAR_PS::Collectors::LinkStatus::Status - A module that provides an object describing the current status of a circuit.

DESCRIPTION

This module is to be treated as an object representing the status of a circuit at a certain point in time.

getTime ($self) Returns the time during which the circuit had this status

getOperState ($self) Returns the operational state

getAdminState ($self) Returns the administrative state

setTime ($self, $time) Sets the time that the status was seen

setOperStatus ($self, $operState) Sets the operation state. Returns 0 if successful. Returns -1 if the operState is not valid.

setAdminStatus ($self, $adminState) Sets the administrative state. Returns 0 if successful. Returns -1 if the adminState is not valid.

updateOperState ($self, $operState) This function updates the operational state with new information. This is used to aggregate the state of a circuit based on the state of its links. So, if for example, an up and a down are seen, the new status will be down.

updateAdminState ($self, $adminState) This function updates the administrative state with new information. This is used to aggregate the state of a circuit based on the state of its links. So, if for example, an normal and a troubleshooting are seen, the new status will be troubleshooting.

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>

COPYRIGHT

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

All rights reserved.