msession documentation stubs added

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@64791 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2001-12-12 09:01:08 +00:00
parent aaf707e3e7
commit 437861fbfb

446
functions/msession.xml Normal file
View file

@ -0,0 +1,446 @@
<reference id="ref.msession">
<title>Mohawk Software session handler functions</title>
<titleabbrev>Msession functions</titleabbrev>
<partintro>
<para>
undocumented
</para>
</partintro>
<refentry id="function.msession-connect">
<refnamediv>
<refname>msession_connect</refname>
<refpurpose>Connect to msession sever </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>msession_connect</function></funcdef>
<paramdef>string <parameter>host</parameter></paramdef>
<paramdef>string <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-disconnect">
<refnamediv>
<refname>msession_disconnect</refname>
<refpurpose>Close connection to msession server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>msession_disconnect</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-count">
<refnamediv>
<refname>msession_count</refname>
<refpurpose>Get session count </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>msession_count</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-create">
<refnamediv>
<refname>msession_create</refname>
<refpurpose>Create a session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>msession_create</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-destroy">
<refnamediv>
<refname>msession_destroy</refname>
<refpurpose>Destroy a session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>msession_destroy</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-lock">
<refnamediv>
<refname>msession_lock</refname>
<refpurpose>Lock a session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>msession_lock</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-unlock">
<refnamediv>
<refname>msession_unlock</refname>
<refpurpose>Unlock a session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>msession_unlock</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>int <parameter>key</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-set">
<refnamediv>
<refname>msession_set</refname>
<refpurpose>Set value in session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>msession_set</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>string <parameter>name</parameter></paramdef>
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-get">
<refnamediv>
<refname>msession_get</refname>
<refpurpose>Get value from session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>msession_get</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>string <parameter>name</parameter></paramdef>
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-uniq">
<refnamediv>
<refname>msession_uniq</refname>
<refpurpose>Get uniq id </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>msession_uniq</function></funcdef>
<paramdef>int <parameter>param</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-randstr">
<refnamediv>
<refname>msession_randstr</refname>
<refpurpose>Get random string </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>msession_randstr</function></funcdef>
<paramdef>int <parameter>param</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-find">
<refnamediv>
<refname>msession_find</refname>
<refpurpose>Find value </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>msession_find</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-list">
<refnamediv>
<refname>msession_list</refname>
<refpurpose>List ... ? </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>msession_list</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-get-array">
<refnamediv>
<refname>msession_get_array</refname>
<refpurpose>Get array of ... ? </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>msession_get_array</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-set-array">
<refnamediv>
<refname>msession_set_array</refname>
<refpurpose>Set array of ... </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>msession_set_array</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>array <parameter>tuples</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-listvar">
<refnamediv>
<refname>msession_listvar</refname>
<refpurpose>List variables in session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>msession_listvar</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-timeout">
<refnamediv>
<refname>msession_timeout</refname>
<refpurpose>Set/get session timeout </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>msession_timeout</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>int
<parameter><optional>param</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-inc">
<refnamediv>
<refname>msession_inc</refname>
<refpurpose>Increment value in session </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>msession_inc</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-getdata">
<refnamediv>
<refname>msession_getdata</refname>
<refpurpose>Get data ... ? </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>msession_getdata</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-setdata">
<refnamediv>
<refname>msession_setdata</refname>
<refpurpose>Set data ... ?</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>msession_setdata</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
<refentry id="function.msession-plugin">
<refnamediv>
<refname>msession_plugin</refname>
<refpurpose>Register a session plugin ... ? </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>msession_plugin</function></funcdef>
<paramdef>string <parameter>session</parameter></paramdef>
<paramdef>string <parameter>val</parameter></paramdef>
<paramdef>string
<parameter><optional>param</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
undocumented
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->