X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2FSessionClient.html;fp=htdocs%2Fdocs%2Fman%2FFS%2FSessionClient.html;h=0000000000000000000000000000000000000000;hp=5f180eee48cb5fd7e436696d35cbaba81c47a92f;hb=1d758388ce3b17b8de1ae1d3a8ec39c1026baefc;hpb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc diff --git a/htdocs/docs/man/FS/SessionClient.html b/htdocs/docs/man/FS/SessionClient.html deleted file mode 100644 index 5f180eee4..000000000 --- a/htdocs/docs/man/FS/SessionClient.html +++ /dev/null @@ -1,97 +0,0 @@ - - -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 $

-

-

-

BUGS

-

-

-

SEE ALSO

-

fs_sessiond

- - - -