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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
package FS::port;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearchs );
use FS::nas;
use FS::session;
@ISA = qw(FS::Record);
=head1 NAME
FS::port - Object methods for port records
=head1 SYNOPSIS
use FS::port;
$record = new FS::port \%hash;
$record = new FS::port { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
$session = $port->session;
=head1 DESCRIPTION
An FS::port object represents an individual port on a NAS. FS::port inherits
from FS::Record. The following fields are currently supported:
=over 4
=item portnum - primary key
=item ip - IP address of this port
=item nasport - port number on the NAS
=item nasnum - NAS this port is on - see L<FS::nas>
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new port. To add the example 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 { 'port'; }
=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;
my $error =
$self->ut_numbern('portnum')
|| $self->ut_ipn('ipn')
|| $self->ut_numbern('nasport')
|| $self->ut_number('nasnum');
;
return $error if $error;
return "Either ip or nasport must be specified"
unless $self->ip || $self->nasport;
return "Unknown nasnum"
unless qsearchs('nas', { 'nasnum' => $self->nasnum } );
''; #no error
}
=item session
Returns the currently open session, or if no session is currently open, the
most recent session. See L<FS::session>.
=cut
=back
=head1 VERSION
$Id: port.pm,v 1.2 2000-12-03 13:44:05 ivan Exp $
=head1 BUGS
The author forgot to customize this manpage.
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=head1 HISTORY
ivan@voicenet.com 97-jul-1
added hfields
ivan@sisd.com 97-nov-13
$Log: port.pm,v $
Revision 1.2 2000-12-03 13:44:05 ivan
beginnings of web status for session monitor
Revision 1.1 2000/10/27 20:18:32 ivan
oops, also necessary for session monitor
Revision 1.1 1999/08/04 08:03:03 ivan
move table subclass examples out of production directory
Revision 1.4 1998/12/29 11:59:57 ivan
mostly properly OO, some work still to be done with svc_ stuff
Revision 1.3 1998/11/15 04:33:00 ivan
updates for newest versoin
Revision 1.2 1998/11/15 03:48:49 ivan
update for current version
=cut
1;
|
