From 46f95157da49cd73ef2a58f357fcd802f578ab69 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 25 Apr 2001 01:06:09 +0000 Subject: [PATCH] missing docs --- htdocs/docs/man/FS/SessionClient.html | 97 +++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 htdocs/docs/man/FS/SessionClient.html diff --git a/htdocs/docs/man/FS/SessionClient.html b/htdocs/docs/man/FS/SessionClient.html new file mode 100644 index 000000000..5f180eee4 --- /dev/null +++ b/htdocs/docs/man/FS/SessionClient.html @@ -0,0 +1,97 @@ + + +FS::SessionClient - Freeside session client API + + + + + + + + +

+ + +

NAME

FS::SessionClient - Freeside session client API

SYNOPSIS

+  use FS::SessionClient qw( login portnum logout );

+  $error = login ( {
+    'username' => $username,
+    'password' => $password,
+    'login'    => $timestamp,
+    'portnum'  => $portnum,
+  } );

+  $portnum = portnum( { 'ip' => $ip } ) or die "unknown ip!"
+  $portnum = portnum( { 'nasnum' => $nasnum, 'nasport' => $nasport } )
+    or die "unknown nasnum/nasport";

+  $error = logout ( {
+    'username' => $username,
+    'password' => $password,
+    'logout'   => $timestamp,
+    'portnum'  => $portnum,
+  } );

DESCRIPTION

This modules provides an API for a remote session application.

It needs to be run as the freeside user. Because of this, the program which +calls these subroutines should be written very carefully.

SUBROUTINES

login HASHREF
+

+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. +

Returns a scalar error message, or the empty string for success.

portnum
+

+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. +

logout HASHREF
+

+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. +

Returns a scalar error message, or the empty string for success.

VERSION

$Id: SessionClient.html,v 1.1 2001-04-25 01:06:09 ivan Exp $

NAME

SYNOPSIS

DESCRIPTION

SUBROUTINES

VERSION

BUGS

SEE ALSO