diff options
Diffstat (limited to 'htdocs/docs/man/FS/port.html')
-rw-r--r-- | htdocs/docs/man/FS/port.html | 120 |
1 files changed, 0 insertions, 120 deletions
diff --git a/htdocs/docs/man/FS/port.html b/htdocs/docs/man/FS/port.html deleted file mode 100644 index b747f0c..0000000 --- a/htdocs/docs/man/FS/port.html +++ /dev/null @@ -1,120 +0,0 @@ -<HTML> -<HEAD> -<TITLE>FS::port - Object methods for port records</TITLE> -<LINK REV="made" HREF="mailto:perl@packages.debian.org"> -</HEAD> - -<BODY> - -<A NAME="__index__"></A> -<!-- INDEX BEGIN --> - -<UL> - - <LI><A HREF="#name">NAME</A></LI> - <LI><A HREF="#synopsis">SYNOPSIS</A></LI> - <LI><A HREF="#description">DESCRIPTION</A></LI> - <LI><A HREF="#methods">METHODS</A></LI> - <LI><A HREF="#version">VERSION</A></LI> - <LI><A HREF="#bugs">BUGS</A></LI> - <LI><A HREF="#see also">SEE ALSO</A></LI> -</UL> -<!-- INDEX END --> - -<HR> -<P> -<H1><A NAME="name">NAME</A></H1> -<P>FS::port - Object methods for port records</P> -<P> -<HR> -<H1><A NAME="synopsis">SYNOPSIS</A></H1> -<PRE> - use FS::port;</PRE> -<PRE> - $record = new FS::port \%hash; - $record = new FS::port { 'column' => 'value' };</PRE> -<PRE> - $error = $record->insert;</PRE> -<PRE> - $error = $new_record->replace($old_record);</PRE> -<PRE> - $error = $record->delete;</PRE> -<PRE> - $error = $record->check;</PRE> -<PRE> - $session = $port->session;</PRE> -<P> -<HR> -<H1><A NAME="description">DESCRIPTION</A></H1> -<P>An FS::port object represents an individual port on a NAS. FS::port inherits -from FS::Record. The following fields are currently supported:</P> -<DL> -<DT><STRONG><A NAME="item_portnum_%2D_primary_key">portnum - primary key</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_ip_%2D_IP_address_of_this_port">ip - IP address of this port</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_nasport_%2D_port_number_on_the_NAS">nasport - port number on the NAS</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_nasnum_%2D_NAS_this_port_is_on_%2D_see_FS%3A%3Anas">nasnum - NAS this port is on - see <A HREF=".././FS/nas.html">the FS::nas manpage</A></A></STRONG><BR> -<DD> -</DL> -<P> -<HR> -<H1><A NAME="methods">METHODS</A></H1> -<DL> -<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR> -<DD> -Creates a new port. To add the example to the database, see <A HREF="#insert">insert</A>. -<P>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 <EM>hash</EM> method.</P> -<P></P> -<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> -<DD> -Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -<P></P> -<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR> -<DD> -Delete this record from the database. -<P></P> -<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR> -<DD> -Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -<P></P> -<DT><STRONG><A NAME="item_check">check</A></STRONG><BR> -<DD> -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. -<P></P> -<DT><STRONG><A NAME="item_session">session</A></STRONG><BR> -<DD> -Returns the currently open session on this port, or if no session is currently -open, the most recent session. See <A HREF=".././FS/session.html">the FS::session manpage</A>. -<P></P></DL> -<P> -<HR> -<H1><A NAME="version">VERSION</A></H1> -<P>$Id: port.html,v 1.1 2001-04-23 12:41:57 ivan Exp $</P> -<P> -<HR> -<H1><A NAME="bugs">BUGS</A></H1> -<P>The author forgot to customize this manpage.</P> -<P>The session method won't deal well if you have multiple open sessions on a -port, for example if your RADIUS server drops <STRONG>stop</STRONG> records. Suggestions for -how to deal with this sort of lossage welcome; should we close the session -when we get a new session on that port? Tag it as invalid somehow? Close it -one second after it was opened? *sigh* Maybe FS::session shouldn't let you -create overlapping sessions, at least folks will find out their logging is -dropping records.</P> -<P>If you think the above refers multiple user logins you need to read the -manpages again.</P> -<P> -<HR> -<H1><A NAME="see also">SEE ALSO</A></H1> -<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, schema.html from the base documentation.</P> - -</BODY> - -</HTML> |