<HTML>
<HEAD>
<TITLE>FS::SessionClient - Freeside session client API</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="#subroutines">SUBROUTINES</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::SessionClient - Freeside session client API</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<PRE>
use FS::SessionClient qw( login portnum logout );</PRE>
<PRE>
$error = login ( {
'username' => $username,
'password' => $password,
'login' => $timestamp,
'portnum' => $portnum,
} );</PRE>
<PRE>
$portnum = portnum( { 'ip' => $ip } ) or die "unknown ip!"
$portnum = portnum( { 'nasnum' => $nasnum, 'nasport' => $nasport } )
or die "unknown nasnum/nasport";</PRE>
<PRE>
$error = logout ( {
'username' => $username,
'password' => $password,
'logout' => $timestamp,
'portnum' => $portnum,
} );</PRE>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>This modules provides an API for a remote session application.</P>
<P>It needs to be run as the freeside user. Because of this, the program which
calls these subroutines should be written very carefully.</P>
<P>
<HR>
<H1><A NAME="subroutines">SUBROUTINES</A></H1>
<DL>
<DT><STRONG><A NAME="item_login">login HASHREF</A></STRONG><BR>
<DD>
HASHREF should have the following keys: username, password, login and portnum.
login is a UNIX timestamp; if not specified, will default to the current time.
Starts a new session for the specified user and portnum. The password is
optional, but must be correct if specified.
<P>Returns a scalar error message, or the empty string for success.</P>
<P></P>
<DT><STRONG><A NAME="item_portnum">portnum</A></STRONG><BR>
<DD>
HASHREF should contain a single key: ip, or the two keys: nasnum and nasport.
Returns a portnum suitable for the login and logout subroutines, or false
on error.
<P></P>
<DT><STRONG><A NAME="item_logout">logout HASHREF</A></STRONG><BR>
<DD>
HASHREF should have the following keys: usrename, password, logout and portnum.
logout is a UNIX timestamp; if not specified, will default to the current time.
Starts a new session for the specified user and portnum. The password is
optional, but must be correct if specified.
<P>Returns a scalar error message, or the empty string for success.</P>
<P></P></DL>
<P>
<HR>
<H1><A NAME="version">VERSION</A></H1>
<P>$Id: SessionClient.html,v 1.1 2001-07-30 07:36:03 ivan Exp $</P>
<P>
<HR>
<H1><A NAME="bugs">BUGS</A></H1>
<P>
<HR>
<H1><A NAME="see also">SEE ALSO</A></H1>
<P><EM>fs_sessiond</EM></P>
</BODY>
</HTML>