mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
4c31e191c5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@69281 c90b9560-bf6c-de11-be94-00142212c4b1
376 lines
12 KiB
XML
376 lines
12 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<reference id="ref.msession">
|
|
<title>Mohawk Software session handler functions</title>
|
|
<titleabbrev>Msession functions</titleabbrev>
|
|
|
|
<partintro>
|
|
<para>
|
|
msession is an interface to a high speed session daemon which can run
|
|
either locally or remotely. It is designed to provide consistent session
|
|
management for a PHP web farm.
|
|
</para>
|
|
<para>
|
|
The session server software can be found at <ulink
|
|
url="&url.msession;">&url.msession;</ulink>.
|
|
</para>
|
|
</partintro>
|
|
|
|
<refentry id="function.msession-connect">
|
|
<refnamediv>
|
|
<refname>msession_connect</refname>
|
|
<refpurpose>Connect to msession server </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>msession_connect</methodname>
|
|
<methodparam><type>string</type><parameter>host</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>port</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-disconnect">
|
|
<refnamediv>
|
|
<refname>msession_disconnect</refname>
|
|
<refpurpose>Close connection to msession server </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>msession_disconnect</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-count">
|
|
<refnamediv>
|
|
<refname>msession_count</refname>
|
|
<refpurpose>Get session count </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>msession_count</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-create">
|
|
<refnamediv>
|
|
<refname>msession_create</refname>
|
|
<refpurpose>Create a session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>msession_create</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-destroy">
|
|
<refnamediv>
|
|
<refname>msession_destroy</refname>
|
|
<refpurpose>Destroy a session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>msession_destroy</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-lock">
|
|
<refnamediv>
|
|
<refname>msession_lock</refname>
|
|
<refpurpose>Lock a session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>msession_lock</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-unlock">
|
|
<refnamediv>
|
|
<refname>msession_unlock</refname>
|
|
<refpurpose>Unlock a session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>msession_unlock</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>key</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-set">
|
|
<refnamediv>
|
|
<refname>msession_set</refname>
|
|
<refpurpose>Set value in session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>msession_set</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-get">
|
|
<refnamediv>
|
|
<refname>msession_get</refname>
|
|
<refpurpose>Get value from session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>msession_get</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-uniq">
|
|
<refnamediv>
|
|
<refname>msession_uniq</refname>
|
|
<refpurpose>Get uniq id </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>msession_uniq</methodname>
|
|
<methodparam><type>int</type><parameter>param</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-randstr">
|
|
<refnamediv>
|
|
<refname>msession_randstr</refname>
|
|
<refpurpose>Get random string </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>msession_randstr</methodname>
|
|
<methodparam><type>int</type><parameter>param</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-find">
|
|
<refnamediv>
|
|
<refname>msession_find</refname>
|
|
<refpurpose>Find value </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>msession_find</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-list">
|
|
<refnamediv>
|
|
<refname>msession_list</refname>
|
|
<refpurpose>List ... ? </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>msession_list</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-get-array">
|
|
<refnamediv>
|
|
<refname>msession_get_array</refname>
|
|
<refpurpose>Get array of ... ? </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>msession_get_array</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-set-array">
|
|
<refnamediv>
|
|
<refname>msession_set_array</refname>
|
|
<refpurpose>Set array of ... </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>msession_set_array</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>tuples</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-listvar">
|
|
<refnamediv>
|
|
<refname>msession_listvar</refname>
|
|
<refpurpose>List sessions with variable</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>msession_listvar</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns an associative array of value, session for all sessions
|
|
with a variable named <parameter>name</parameter>.
|
|
</para>
|
|
<para>
|
|
Used for searching sessions with common attributes.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-timeout">
|
|
<refnamediv>
|
|
<refname>msession_timeout</refname>
|
|
<refpurpose>Set/get session timeout </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>msession_timeout</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>param</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-inc">
|
|
<refnamediv>
|
|
<refname>msession_inc</refname>
|
|
<refpurpose>Increment value in session </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>msession_inc</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-getdata">
|
|
<refnamediv>
|
|
<refname>msession_getdata</refname>
|
|
<refpurpose>Get data ... ? </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>msession_getdata</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-setdata">
|
|
<refnamediv>
|
|
<refname>msession_setdata</refname>
|
|
<refpurpose>Set data ... ?</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>msession_setdata</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.msession-plugin">
|
|
<refnamediv>
|
|
<refname>msession_plugin</refname>
|
|
<refpurpose>Call an escape function within the msession personality plugin</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>msession_plugin</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>val</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>param</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
</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
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|
|
|