[srm-cvs] CVS Update: - More docs

Date: Mon Mar 11 08:19:21 CET 2002
User: Derick Rethans
Directory: srmdoc/user

Log Message:
 [0.25]
 - More docs
 
Modified files:
           srmdoc/user/mod_standard.xml (version: 1.2)

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

--- srmdoc/user/mod_standard.xml:1.1 Fri Mar 08 22:39:46 2002 GMT
+++ srmdoc/user/mod_standard.xml Mon Mar 11 06:19:20 2002 GMT
@@ -118,6 +118,11 @@
     <void/>
    </methodsynopsis>
    <para>
+ This function returns a list with loaded modules.
+ </para>
+ <para>
+ See also: <function>srm_module_info</function> and
+ <function>srm_module_exists</function>.
    </para>
   </refsect1>
  </refentry>
@@ -126,6 +131,7 @@
   <refnamediv>
    <refname>srm_module_exists</refname>
    <refpurpose>
+ Checks if a specific module has been loaded into the daemon.
    </refpurpose>
   </refnamediv>
   <refsect1>
@@ -135,6 +141,13 @@
     <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
    </methodsynopsis>
    <para>
+ This function tests if a the specified <parameter>module_name</parameter>
+ has been loaded into the Daemon. It returns TRUE if the module was loaded,
+ or FALSE if it is not loaded.
+ </para>
+ <para>
+ See also: <function>srm_module_list</function> and
+ <function>srm_module_info</function>.
    </para>
   </refsect1>
  </refentry>
@@ -143,6 +156,7 @@
   <refnamediv>
    <refname>srm_module_info</refname>
    <refpurpose>
+ Return detailed info about a module.
    </refpurpose>
   </refnamediv>
   <refsect1>
@@ -152,6 +166,37 @@
     <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
    </methodsynopsis>
    <para>
+ This function returns info in an array. The
+ <parameter>module_name</parameter> specifies from which module the
+ information is returned. The returned array has the following format:
+ </para>
+ <para>
+ <programlisting role="php">
+&lt;?php
+ $srm = new SRM ("/tmp/srm.socket", 7777);
+ var_dump ($srm-&gt;srm_function_info('sphp'));
+?&gt;
+
+array(4) {
+ [0]=>
+ string(12) "PHP 4 / Zend"
+ [1]=>
+ string(5) "0.6.1"
+ [2]=>
+ string(9) "PHP Group"
+ [3]=>
+ string(18) "Scripting Language"
+}
+ </programlisting>
+ </para>
+ <para>
+ The first entry is the name of the module, the second the version of the
+ module, the third the name of the vendor and the fourth is a description
+ of the module.
+ </para>
+ <para>
+ See also: <function>srm_module_list</function> and
+ <function>srm_module_exists</function>.
    </para>
   </refsect1>
  </refentry>
@@ -160,6 +205,7 @@
   <refnamediv>
    <refname>srm_application_keys</refname>
    <refpurpose>
+ Returns a list with all stored application keys.
    </refpurpose>
   </refnamediv>
   <refsect1>
@@ -177,6 +223,7 @@
   <refnamediv>
    <refname>srm_session_keys</refname>
    <refpurpose>
+ Returns a list with all stored session keys.
    </refpurpose>
   </refnamediv>
   <refsect1>
@@ -194,6 +241,7 @@
   <refnamediv>
    <refname>lock</refname>
    <refpurpose>
+ Obtains an advisory lock on a application variable.
    </refpurpose>
   </refnamediv>
   <refsect1>
@@ -211,6 +259,7 @@
   <refnamediv>
    <refname>unlock</refname>
    <refpurpose>
+ Releases a lock on a application variable.
    </refpurpose>
   </refnamediv>
   <refsect1>
Received on Mon Mar 11 08:25:05 2002