[srm-cvs] CVS Update: - Add basic docs for the standard module

Date: Sat Mar 9 00:39:46 CET 2002
User: Derick Rethans
Directory: srmdoc/user

Log Message:
 [0.75]
 - Add basic docs for the standard module
 
Added files:
           srmdoc/user/mod_standard.xml (new version: 1.1)

[FILE: /srmdoc/user/mod_standard.xml]

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.85 $ -->
<reference id="mod_standard">
 <title>Module Standard</title>

 <refentry id="module.standard.srm_version">
  <refnamediv>
   <refname>srm_version</refname>
   <refpurpose>
    Retrieve the version number from the SRM Daemon.
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>int</type><methodname>srm_version</methodname>
    <void/>
   </methodsynopsis>
   <para>
    The returned version number looks like <literal>20020223</literal>. At
    this moment the version number is not a real version number, but a
    timestamp of the last <literal>./configure</literal>. In the future this
    version number will no be changed by configure anymore, but fixed per
    release.
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_function_list">
  <refnamediv>
   <refname>srm_function_list</refname>
   <refpurpose>
    Return a list with all supported functions.
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>array</type><methodname>srm_function_list</methodname>
    <void/>
   </methodsynopsis>
   <para>
    This function returns an array in which each element is a function
    supported by the SRM Daemon. Both internal functions, functions from
    modules and functions from function libraries, where the functions are
    written in PHP are returned. If the function is a function from the
    function library, the suffix <literal>(PHP)</literal> is added.
   </para>
   <para>
    Below you find a shortened returned array from this function.
   </para>
   <para>
    <programlisting role="php">
&lt;?php
    $srm = new SRM ("/tmp/srm.socket", 7777);
    var_dump ($srm-&gt;srm_function_list());
?&gt;

array(7) {
  [0]=&gt;
  string(20) "banana_function_call"
  [1]=&gt;
  string(6) "unlock"
  [2]=&gt;
  string(16) "auth_get_timeout"
  [3]=&gt;
  string(13) "srm_add (PHP)"
  [4]=&gt;
  string(11) "auth_logout"
  [5]=&gt;
  string(13) "srm_sub (PHP)"
  [6]=&gt;
  string(12) "uptime (PHP)"
}
    </programlisting>
   </para>
   <para>
    See also: <function>srm_function_exists</function>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_function_exists">
  <refnamediv>
   <refname>srm_function_exists</refname>
   <refpurpose>
    Check if a function is supported by the Daemon.
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>srm_function_exists</methodname>
    <methodparam><type>string</type><parameter>function_name</parameter></methodparam>
   </methodsynopsis>
   <para>
    With this function you can check whether a specific function is supported.
    The <parameter>function_name</parameter> is the name of the function that
    you want to check availabilty for.
   </para>
   <para>
    See also: <function>srm_function_list</function>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_module_list">
  <refnamediv>
   <refname>srm_module_list</refname>
   <refpurpose>
    Retrieve a list with all loaded modules.
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>array</type><methodname>srm_module_list</methodname>
    <void/>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_module_exists">
  <refnamediv>
   <refname>srm_module_exists</refname>
   <refpurpose>
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>srm_module_exists</methodname>
    <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_module_info">
  <refnamediv>
   <refname>srm_module_info</refname>
   <refpurpose>
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>srm_module_info</methodname>
    <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_application_keys">
  <refnamediv>
   <refname>srm_application_keys</refname>
   <refpurpose>
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>srm_application_keys</methodname>
    <void/>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.srm_session_keys">
  <refnamediv>
   <refname>srm_session_keys</refname>
   <refpurpose>
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>srm_session_keys</methodname>
    <void/>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.lock">
  <refnamediv>
   <refname>lock</refname>
   <refpurpose>
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>lock</methodname>
    <methodparam><type>string</type><parameter>variable</parameter></methodparam>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

 <refentry id="module.standard.unlock">
  <refnamediv>
   <refname>unlock</refname>
   <refpurpose>
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
   <methodsynopsis>
    <type>bool</type><methodname>unlock</methodname>
    <methodparam><type>string</type><parameter>variable</parameter></methodparam>
   </methodsynopsis>
   <para>
   </para>
  </refsect1>
 </refentry>

</reference>
<!-- keep this comment at the end of the file
vim600: syn=xml fen fdm=syntax fdl=4 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Received on Sat Mar 9 00:45:13 2002