summaryrefslogtreecommitdiff
path: root/FS/FS/nas.pm
blob: 2d17df899789a97b7411c875cc20355386fc4715 (plain)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
package FS::nas;

use strict;
use vars qw( @ISA );
use FS::Record qw(qsearchs); #qsearch);
use FS::UID qw( dbh );

@ISA = qw(FS::Record);

=head1 NAME

FS::nas - Object methods for nas records

=head1 SYNOPSIS

  use FS::nas;

  $record = new FS::nas \%hash;
  $record = new FS::nas {
    'nasnum'  => 1,
    'nasip'   => '10.4.20.23',
    'nasfqdn' => 'box1.brc.nv.us.example.net',
  };

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

  $error = $record->heartbeat($timestamp);

=head1 DESCRIPTION

An FS::nas object represents an Network Access Server on your network, such as
a terminal server or equivalent.  FS::nas inherits from FS::Record.  The
following fields are currently supported:

=over 4

=item nasnum - primary key

=item nas - NAS name

=item nasip - NAS ip address

=item nasfqdn - NAS fully-qualified domain name

=item last - timestamp indicating the last instant the NAS was in a known
             state (used by the session monitoring).

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new NAS.  To add the NAS to the database, see L<"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 I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'nas'; }

=item insert

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

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=cut

# the replace method can be inherited from FS::Record

=item check

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

=cut

# the check method should currently be supplied - FS::Record contains some
# data checking routines

sub check {
  my $self = shift;

  $self->ut_numbern('nasnum')
    || $self->ut_text('nas')
    || $self->ut_ip('nasip')
    || $self->ut_domain('nasfqdn')
    || $self->ut_numbern('last')
    || $self->SUPER::check
    ;
}

=item heartbeat TIMESTAMP

Updates the timestamp for this nas

=cut

sub heartbeat {
  my($self, $timestamp) = @_;
  my $dbh = dbh;
  my $sth =
    $dbh->prepare("UPDATE nas SET last = ? WHERE nasnum = ? AND last < ?");
  $sth->execute($timestamp, $self->nasnum, $timestamp) or die $sth->errstr;
  $self->last($timestamp);
}

=back

=head1 VERSION

$Id: nas.pm,v 1.7 2003-08-05 00:20:43 khoff Exp $

=head1 BUGS

heartbeat method uses SQL directly and doesn't update history tables.

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;