<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::addr_status;

NAME

FS::addr_status;

SYNOPSIS

  use FS::addr_status;

  $record = new FS::addr_status \%hash;
  $record = new FS::addr_status { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

DESCRIPTION

An FS::addr_status object represents the last known status (up or down, and the latency) of an IP address monitored by freeside-pingd. FS::addr_status inherits from FS::Record. The following fields are currently supported:

addrnum - primary key
ip_addr - the IP address (unique)
_date - the time the address was last scanned
up - 'Y' if the address responded to a ping
delay - the latency, in milliseconds

METHODS

new HASHREF

Creates a new status record. To add the record to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete
replace OLD_RECORD
check

Checks all fields to make sure this is a valid status record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

SEE ALSO

FS::Record

<% include ('/elements/footer.html' ) %>