cvs: peardoc /en/package/networking net-server.xml /en/package/networking/net-server constants.xml /en/package/networking/net-server/net-server
create.xml /en/package/networking/net-server/net-server-driver getlastsocketerror.xml setcallbackobject.xml setdebugmode.xml
/en/package/networking/net-server/net-server-driver-fork broadcastdata.xml closeconnection.xml getclientinfo.xml getclients.xml isconnected.xml
senddata.xml servicerequest.xml setmaxclients.xml shutdown.xml start.xml /en/package/networking/net-server/net-server-driver-sequential
acceptconnection.xml broadcastdata.xml closeconnection.xml getclientinfo.xml getclients.xml isconnected.xml senddata.xml setmaxclients.xml
shutdown.xml start.xml /en/package/networking/net-server/net-server-handler onclose.xml onconnect.xml onconnectionrefused.xml onreceivedata.xml
onshutdown.xml onstart.xml setserverreference.xml
| From: | Stephan Schmidt | Date: | Fri, 02 Jan 2004 17:35:34 +0000 |
| Subject: | cvs: peardoc /en/package/networking net-server.xml /en/package/networking/net-server constants.xml /en/package/networking/net-server/net-server create.xml /en/package/networking/net-server/net-server-driver getlastsocketerror.xml setcallbackobject.xml setdebugmode.xml /en/package/networking/net-server/net-server-driver-fork broadcastdata.xml closeconnection.xml getclientinfo.xml getclients.xml isconnected.xml senddata.xml servicerequest.xml setmaxclients.xml shutdown.xml start.xml /en/package/networking/net-server/net-server-driver-sequential acceptconnection.xml broadcastdata.xml closeconnection.xml getclientinfo.xml getclients.xml isconnected.xml senddata.xml setmaxclients.xml shutdown.xml start.xml /en/package/networking/net-server/net-server-handler onclose.xml onconnect.xml onconnectionrefused.xml onreceivedata.xml onshutdown.xml onstart.xml setserverreference.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-2089@lists.php.net to get a copy of this message | ||
schst Fri Jan 2 12:35:34 2004 EDT
Added files:
/peardoc/en/package/networking/net-server constants.xml
/peardoc/en/package/networking/net-server/net-server-driver-fork
broadcastdata.xml
closeconnection.xml
getclientinfo.xml
getclients.xml
isconnected.xml
senddata.xml
servicerequest.xml
setmaxclients.xml
shutdown.xml
start.xml
/peardoc/en/package/networking/net-server/net-server-driver-sequential
acceptconnection.xml
broadcastdata.xml
closeconnection.xml
getclientinfo.xml
getclients.xml
isconnected.xml
senddata.xml
setmaxclients.xml
shutdown.xml
start.xml
/peardoc/en/package/networking/net-server/net-server-driver
getlastsocketerror.xml
setcallbackobject.xml
setdebugmode.xml
/peardoc/en/package/networking/net-server/net-server-handler
onclose.xml
onconnect.xml
onconnectionrefused.xml
onreceivedata.xml
onshutdown.xml
onstart.xml
setserverreference.xml
/peardoc/en/package/networking/net-server/net-server create.xml
Modified files:
/peardoc/en/package/networking net-server.xml
Log:
added generated API docs
Index: peardoc/en/package/networking/net-server.xml diff -u peardoc/en/package/networking/net-server.xml:1.1 peardoc/en/package/networking/net-server.xml:1.2 --- peardoc/en/package/networking/net-server.xml:1.1 Mon Dec 29 06:59:11 2003 +++ peardoc/en/package/networking/net-server.xml Fri Jan 2 12:35:29 2004 @@ -1,15 +1,294 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <sect1 id="package.networking.net-server"> - <title>Net_Server</title> - +<title>Net_Server</title> <para> Generic server package for creating daemons. </para> - &package.networking.net-server.intro; &package.networking.net-server.example; - - </sect1> +<refentry id="package.networking.net-server.net-server-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server</classname></refname> + <refpurpose>PHP socket server base class</refpurpose> + </refnamediv> + +<refsect1> + <title>PHP socket server base class</title> + <para>This class must only be used to create a new server using the static method 'create()'.</para> +<para>To handle the events that happen while the server is running you have to create a new class that handles all events.</para> +<para><programlisting role="php-highlighted">1 require_once 'myHandler.php'; +2 require_once 'Net/Server.php'; +3 +4 $server = &<link linkend="package.networking.net-server.net-server-summary">Net_Server</link>::<link linkend="package.networking.net-server.net-server.create">create</link>('fork', 'localhost', 9090); +5 +6 $handler = &new myHandler; +7 +8 $server->setCallbackObject($handler); +9 +10 $server->start(); +</programlisting></para> +<para>See Server/Handler.php for a baseclass that you can use to implement new handlers.</para> + +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server</classname></title> + <para> + <itemizedlist> + <listitem><para> + Net_Server + </para></listitem> + </itemizedlist> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server.create; +<refentry id="package.networking.net-server.net-server-driver-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Driver</classname></refname> + <refpurpose>Base class for all drivers</refpurpose> + </refnamediv> +<refsect1> + <title>Base class for all drivers</title> + ¬documented; +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Driver</classname></title> + <para> + <itemizedlist> + <listitem><para> + PEAR + <itemizedlist> + <listitem><para> + Net_Server_Driver + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + <para> + <table> + <title>Classes that extend <classname>Net_Server_Driver</classname></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class</entry> + <entry>Summary</entry> + </row> + </thead> + <tbody> + <row> + <entry><link linkend="package.networking.net-server.net-server-driver-fork-summary">Net_Server_Driver_Fork</link></entry> + <entry>Forking server class.</entry> + </row> + <row> + <entry><link linkend="package.networking.net-server.net-server-driver-sequential-summary">Net_Server_Driver_Sequential</link></entry> + <entry>Sequential server class.</entry> + </row> + </tbody> + </tgroup> + </table> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-driver.getlastsocketerror; +&package.networking.net-server.net-server-driver.setcallbackobject; +&package.networking.net-server.net-server-driver.setdebugmode; +<refentry id="package.networking.net-server.net-server-driver-fork-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Driver_Fork</classname></refname> + <refpurpose>Forking server class.</refpurpose> + </refnamediv> +<refsect1> + <title>Forking server class.</title> + <para>This class will fork a new process for each connection. This allows you to build servers, where communication between the clients is no issue.</para> +<para>Events that can be handled: +<itemizedlist> +<listitem><para>onStart</para></listitem> + +<listitem><para>onConnect</para></listitem> + +<listitem><para>onClose</para></listitem> + +<listitem><para>onReceiveData</para></listitem> +</itemizedlist></para> + +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Driver_Fork</classname></title> + <para> + <itemizedlist> + <listitem><para> + PEAR + <itemizedlist> + <listitem><para> + <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link> + <itemizedlist> + <listitem><para> + Net_Server_Driver_Fork + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + <para> + <classname>Net_Server_Driver_Fork</classname> Inherited Methods + </para> + <para> + <table> + <title>Inherited from <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Method Name</entry> + <entry>Summary</entry> + </row> + </thead> + <tbody> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.getlastsocketerror"><function>Net_Server_Driver::getLastSocketError</function></link></entry> + <entry>return string for last socket error</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setcallbackobject"><function>Net_Server_Driver::setCallbackObject</function></link></entry> + <entry>register a callback object, that is used to handle all events</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setdebugmode"><function>Net_Server_Driver::setDebugMode</function></link></entry> + <entry>set debug mode</entry> + </row> + </tbody> + </tgroup> + </table> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-driver-fork.broadcastdata; +&package.networking.net-server.net-server-driver-fork.closeconnection; +&package.networking.net-server.net-server-driver-fork.getclientinfo; +&package.networking.net-server.net-server-driver-fork.getclients; +&package.networking.net-server.net-server-driver-fork.isconnected; +&package.networking.net-server.net-server-driver-fork.senddata; +&package.networking.net-server.net-server-driver-fork.servicerequest; +&package.networking.net-server.net-server-driver-fork.setmaxclients; +&package.networking.net-server.net-server-driver-fork.shutdown; +&package.networking.net-server.net-server-driver-fork.start; +<refentry id="package.networking.net-server.net-server-driver-sequential-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Driver_Sequential</classname></refname> + <refpurpose>Sequential server class.</refpurpose> + </refnamediv> +<refsect1> + <title>Sequential server class.</title> + <para>This class will handles all connection in one server process. This allows you to build servers, where communication between the clients is easy. The drawback is that clients are served sequentially (hence the name). If you send large blocks of data to a client, the others will have to wait. For servers where communication between clients is not needed, use Net_Server_Fork instead.</para> +<para>Events that can be handled: +<itemizedlist> +<listitem><para>onStart</para></listitem> + +<listitem><para>onConnect</para></listitem> + +<listitem><para>onConnectionRefused</para></listitem> + +<listitem><para>onClose</para></listitem> + +<listitem><para>onReceiveData</para></listitem> + +<listitem><para>onShutdown</para></listitem> +</itemizedlist></para> + +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Driver_Sequential</classname></title> + <para> + <itemizedlist> + <listitem><para> + PEAR + <itemizedlist> + <listitem><para> + <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link> + <itemizedlist> + <listitem><para> + Net_Server_Driver_Sequential + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + <para> + <classname>Net_Server_Driver_Sequential</classname> Inherited Methods + </para> + <para> + <table> + <title>Inherited from <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Method Name</entry> + <entry>Summary</entry> + </row> + </thead> + <tbody> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.getlastsocketerror"><function>Net_Server_Driver::getLastSocketError</function></link></entry> + <entry>return string for last socket error</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setcallbackobject"><function>Net_Server_Driver::setCallbackObject</function></link></entry> + <entry>register a callback object, that is used to handle all events</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setdebugmode"><function>Net_Server_Driver::setDebugMode</function></link></entry> + <entry>set debug mode</entry> + </row> + </tbody> + </tgroup> + </table> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-driver-sequential.acceptconnection; +&package.networking.net-server.net-server-driver-sequential.broadcastdata; +&package.networking.net-server.net-server-driver-sequential.closeconnection; +&package.networking.net-server.net-server-driver-sequential.getclientinfo; +&package.networking.net-server.net-server-driver-sequential.getclients; +&package.networking.net-server.net-server-driver-sequential.isconnected; +&package.networking.net-server.net-server-driver-sequential.senddata; +&package.networking.net-server.net-server-driver-sequential.setmaxclients; +&package.networking.net-server.net-server-driver-sequential.shutdown; +&package.networking.net-server.net-server-driver-sequential.start; +<refentry id="package.networking.net-server.net-server-handler-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Handler</classname></refname> + <refpurpose>Base class for all handlers</refpurpose> + </refnamediv> +<refsect1> + <title>Base class for all handlers</title> + ¬documented; +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Handler</classname></title> + <para> + <itemizedlist> + <listitem><para> + Net_Server_Handler + </para></listitem> + </itemizedlist> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-handler.onclose; +&package.networking.net-server.net-server-handler.onconnect; +&package.networking.net-server.net-server-handler.onconnectionrefused; +&package.networking.net-server.net-server-handler.onreceivedata; +&package.networking.net-server.net-server-handler.onshutdown; +&package.networking.net-server.net-server-handler.onstart; +&package.networking.net-server.net-server-handler.setserverreference; +&package.networking.net-server.constants; +</sect1> +<!-- Generated by phpDocumentor v 1.2.3 http://www.phpdoc.org --> <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -20,7 +299,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil -sgml-default-dtd-file:"../../../manual.ced" +sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil @@ -28,4 +307,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +--> \ No newline at end of file Index: peardoc/en/package/networking/net-server/constants.xml +++ peardoc/en/package/networking/net-server/constants.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.constants"> <refnamediv> <refname>Package Net_Server Constants</refname> <refpurpose>Constants defined in and used by Net_Server</refpurpose> </refnamediv> <refsect1 id="package.networking.net-server.constants.details"> <title>All Constants</title> <refsect2 id="package.networking.net-server.constants.details.server---php"> <title> Constants defined in Server.php </title> <para> <table> <title>Constants defined in Server.php</title> <tgroup cols="3"> <thead> <row> <entry>Name</entry> <entry>Value</entry> <entry>Line Number</entry> </row> </thead> <tbody> <row> <entry>NET_SERVER_ERROR_DRIVER_CORRUPT</entry> <entry>52</entry> <entry>39</entry> </row> <row> <entry>NET_SERVER_ERROR_NOT_SUPPORTED</entry> <entry>53</entry> <entry>44</entry> </row> <row> <entry>NET_SERVER_ERROR_PCNTL_REQUIRED</entry> <entry>54</entry> <entry>49</entry> </row> <row> <entry>NET_SERVER_ERROR_UNKNOWN_DRIVER</entry> <entry>51</entry> <entry>34</entry> </row> </tbody> </tgroup> </table> </para> </refsect2> </refsect1> </refentry> <!-- Generated by phpDocumentor v 1.2.3 http://www.phpdoc.org --> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/broadcastdata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/broadcastdata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.broadcastdata"> <refnamediv> <refname><function>Net_Server_Driver_Fork::broadcastData</function></refname> <refpurpose>send data to all clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::broadcastData</function></funcdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>array <parameter> <optional>$exclude = array()</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$exclude</parameter> </term> <listitem> <para> client ids to exclude </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/closeconnection.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/closeconnection.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.closeconnection"> <refnamediv> <refname><function>Net_Server_Driver_Fork::closeConnection</function></refname> <refpurpose>close the current connection</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::closeConnection</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.closeconnection.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.closeconnection.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.closeconnection.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/getclientinfo.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/getclientinfo.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.getclientinfo"> <refnamediv> <refname><function>Net_Server_Driver_Fork::getClientInfo</function></refname> <refpurpose>get current information about a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>Net_Server_Driver_Fork::getClientInfo</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.returns"> &title.returns; <para> <emphasis>returns</emphasis> information about the client </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/getclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/getclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.getclients"> <refnamediv> <refname><function>Net_Server_Driver_Fork::getClients</function></refname> <refpurpose>get current amount of clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>PEAR_Error <function>Net_Server_Driver_Fork::getClients</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclients.desc"> &title.desc; <para>not possible with forking</para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/isconnected.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/isconnected.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.isconnected"> <refnamediv> <refname><function>Net_Server_Driver_Fork::isConnected</function></refname> <refpurpose>check, whether a client is still connected</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>Net_Server_Driver_Fork::isConnected</function></funcdef> <paramdef>integer <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$id</parameter> </term> <listitem> <para> client id </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.returns"> &title.returns; <para> <emphasis>returns</emphasis> true if client is connected, false otherwise </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/senddata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/senddata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.senddata"> <refnamediv> <refname><function>Net_Server_Driver_Fork::sendData</function></refname> <refpurpose>send data to a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::sendData</function></funcdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>boolean <parameter> <optional>$debugData = &true;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$debugData</parameter> </term> <listitem> <para> flag to indicate whether data that is written to socket should also be sent as debug message </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/servicerequest.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/servicerequest.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.servicerequest"> <refnamediv> <refname><function>Net_Server_Driver_Fork::serviceRequest</function></refname> <refpurpose>service the current request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::serviceRequest</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.servicerequest.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.servicerequest.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.servicerequest.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/setmaxclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/setmaxclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.setmaxclients"> <refnamediv> <refname><function>Net_Server_Driver_Fork::setMaxClients</function></refname> <refpurpose>set maximum amount of simultaneous connections</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::setMaxClients</function></funcdef> <paramdef>int <parameter>$maxClients</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.desc"> &title.desc; <para>this is not possible as each client gets its own process</para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$maxClients</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/shutdown.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/shutdown.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.shutdown"> <refnamediv> <refname><function>Net_Server_Driver_Fork::shutDown</function></refname> <refpurpose>shutdown server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::shutDown</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.shutdown.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.shutdown.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.shutdown.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/start.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/start.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.start"> <refnamediv> <refname><function>Net_Server_Driver_Fork::start</function></refname> <refpurpose>start the server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::start</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.start.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.start.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.start.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/acceptconnection.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/acceptconnection.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.acceptconnection"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::acceptConnection</function></refname> <refpurpose>accept a new connection</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>Net_Server_Driver_Sequential::acceptConnection</function></funcdef> <paramdef>resource <parameter>&$socket</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.resource; <parameter>&$socket</parameter> </term> <listitem> <para> socket that received the new connection </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.returns"> &title.returns; <para> <emphasis>returns</emphasis> internal ID of the client </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/broadcastdata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/broadcastdata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.broadcastdata"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::broadcastData</function></refname> <refpurpose>send data to all clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::broadcastData</function></funcdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>array <parameter> <optional>$exclude = array()</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$exclude</parameter> </term> <listitem> <para> client ids to exclude </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/closeconnection.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/closeconnection.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.closeconnection"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::closeConnection</function></refname> <refpurpose>close connection to a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::closeConnection</function></funcdef> <paramdef>mixed <parameter> <optional>$id = 0</optional></parameter></paramdef> <paramdef>int <parameter>$clientID</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$id</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientID</parameter> </term> <listitem> <para> internal ID of the client </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/getclientinfo.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/getclientinfo.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.getclientinfo"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::getClientInfo</function></refname> <refpurpose>get current information about a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>Net_Server_Driver_Sequential::getClientInfo</function></funcdef> <paramdef>int <parameter>$clientId</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> ID of the client </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.returns"> &title.returns; <para> <emphasis>returns</emphasis> information about the client </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/getclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/getclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.getclients"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::getClients</function></refname> <refpurpose>get current amount of clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>Net_Server_Driver_Sequential::getClients</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.returns"> &title.returns; <para> <emphasis>returns</emphasis> amount of clients </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/isconnected.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/isconnected.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.isconnected"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::isConnected</function></refname> <refpurpose>check, whether a client is still connected</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>Net_Server_Driver_Sequential::isConnected</function></funcdef> <paramdef>integer <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$id</parameter> </term> <listitem> <para> client id </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.returns"> &title.returns; <para> <emphasis>returns</emphasis> true if client is connected, false otherwise </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/senddata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/senddata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.senddata"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::sendData</function></refname> <refpurpose>send data to a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::sendData</function></funcdef> <paramdef>int <parameter>$clientId</parameter></paramdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>boolean <parameter> <optional>$debugData = &true;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> ID of the client </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$debugData</parameter> </term> <listitem> <para> flag to indicate whether data that is written to socket should also be sent as debug message </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/setmaxclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/setmaxclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.setmaxclients"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::setMaxClients</function></refname> <refpurpose>set maximum amount of simultaneous connections</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::setMaxClients</function></funcdef> <paramdef>int <parameter>$maxClients</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$maxClients</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/shutdown.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/shutdown.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.shutdown"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::shutDown</function></refname> <refpurpose>shutdown server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::shutDown</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.shutdown.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.shutdown.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.shutdown.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/start.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/start.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.start"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::start</function></refname> <refpurpose>start the server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::start</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.start.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.start.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.start.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver/getlastsocketerror.xml +++ peardoc/en/package/networking/net-server/net-server-driver/getlastsocketerror.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver.getlastsocketerror"> <refnamediv> <refname><function>Net_Server_Driver::getLastSocketError</function></refname> <refpurpose>return string for last socket error</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriver.php'; </funcsynopsisinfo> <funcprototype> <funcdef>string <function>Net_Server_Driver::getLastSocketError</function></funcdef> <paramdef>mixed <parameter>&$fd</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>&$fd</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.returns"> &title.returns; <para> <emphasis>returns</emphasis> last error </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver/setcallbackobject.xml +++ peardoc/en/package/networking/net-server/net-server-driver/setcallbackobject.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver.setcallbackobject"> <refnamediv> <refname><function>Net_Server_Driver::setCallbackObject</function></refname> <refpurpose>register a callback object, that is used to handle all events</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriver.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver::setCallbackObject</function></funcdef> <paramdef>object <parameter>&$object</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <parameter>&$object</parameter> </term> <listitem> <para> callback object </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver/setdebugmode.xml +++ peardoc/en/package/networking/net-server/net-server-driver/setdebugmode.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver.setdebugmode"> <refnamediv> <refname><function>Net_Server_Driver::setDebugMode</function></refname> <refpurpose>set debug mode</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriver.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver::setDebugMode</function></funcdef> <paramdef>mixed <parameter>$debug</parameter></paramdef> <paramdef>string <parameter> <optional>$dest = "stdout"</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$debug</parameter> </term> <listitem> <para> [text|html&false;] </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$dest</parameter> </term> <listitem> <para> destination of debug message (stdout to output or filename if log should be written) </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onclose.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onclose.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onclose"> <refnamediv> <refname><function>Net_Server_Handler::onClose</function></refname> <refpurpose>onClose handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onClose</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onclose.desc"> &title.desc; <para>This handler is called, when a client disconnects from the server Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onclose.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client, in Net_Server_Fork, this is always 0 </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onclose.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onclose.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onconnect.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onconnect.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onconnect"> <refnamediv> <refname><function>Net_Server_Handler::onConnect</function></refname> <refpurpose>onConnect handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onConnect</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.desc"> &title.desc; <para>This handler is called, when a new client connects Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client, in Net_Server_Fork, this is always 0 </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onconnectionrefused.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onconnectionrefused.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onconnectionrefused"> <refnamediv> <refname><function>Net_Server_Handler::onConnectionRefused</function></refname> <refpurpose>onConnectionRefused handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onConnectionRefused</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.desc"> &title.desc; <para>This handler is called, when a new client tries to connect but is not allowed to Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onreceivedata.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onreceivedata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onreceivedata"> <refnamediv> <refname><function>Net_Server_Handler::onReceiveData</function></refname> <refpurpose>onReceiveData handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onReceiveData</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$data = ""</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.desc"> &title.desc; <para>This handler is called, when a client sends data to the server Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client, in Net_Server_Fork, this is always 0 </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data that the client sent </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onshutdown.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onshutdown.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onshutdown"> <refnamediv> <refname><function>Net_Server_Handler::onShutdown</function></refname> <refpurpose>onShutdown handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onShutdown</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onshutdown.desc"> &title.desc; <para>This handler is called, when the server is stopped. Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onshutdown.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onshutdown.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onstart.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onstart.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onstart"> <refnamediv> <refname><function>Net_Server_Handler::onStart</function></refname> <refpurpose>onStart handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onStart</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onstart.desc"> &title.desc; <para>This handler is called, when the server starts. Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onstart.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onstart.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/setserverreference.xml +++ peardoc/en/package/networking/net-server/net-server-handler/setserverreference.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.setserverreference"> <refnamediv> <refname><function>Net_Server_Handler::setServerReference</function></refname> <refpurpose>set a reference to the server object</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::setServerReference</function></funcdef> <paramdef>object Net_Server_* <parameter>&$server</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.desc"> &title.desc; <para>This is done automatically when the handler is passed over to the server</para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object Net_Server_*; <parameter>&$server</parameter> </term> <listitem> <para> object </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server/create.xml +++ peardoc/en/package/networking/net-server/net-server/create.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server.create"> <refnamediv> <refname><function>Net_Server::create</function></refname> <refpurpose>create a new server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'Server.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void& <function>Net_Server::create</function></funcdef> <paramdef>string <parameter>$type</parameter></paramdef> <paramdef>string <parameter>$host</parameter></paramdef> <paramdef>integer <parameter>$port</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server.create.desc"> &title.desc; <para>Currently two types of servers are supported: <itemizedlist> <listitem><para>'sequential', creates a server where one process handles all request from all clients sequentially</para></listitem> <listitem><para>'fork', creates a server where a new process is forked for each client that connects to the server. This only works on *NIX</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$type</parameter> </term> <listitem> <para> type of the server </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$host</parameter> </term> <listitem> <para> hostname </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$port</parameter> </term> <listitem> <para> port </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.static"> <title>static</title> <para> <emphasis>static</emphasis> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
Index: peardoc/en/package/networking/net-server.xml diff -u peardoc/en/package/networking/net-server.xml:1.1 peardoc/en/package/networking/net-server.xml:1.2 --- peardoc/en/package/networking/net-server.xml:1.1 Mon Dec 29 06:59:11 2003 +++ peardoc/en/package/networking/net-server.xml Fri Jan 2 12:35:29 2004 @@ -1,15 +1,294 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <sect1 id="package.networking.net-server"> - <title>Net_Server</title> - +<title>Net_Server</title> <para> Generic server package for creating daemons. </para> - &package.networking.net-server.intro; &package.networking.net-server.example; - - </sect1> +<refentry id="package.networking.net-server.net-server-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server</classname></refname> + <refpurpose>PHP socket server base class</refpurpose> + </refnamediv> + +<refsect1> + <title>PHP socket server base class</title> + <para>This class must only be used to create a new server using the static method 'create()'.</para> +<para>To handle the events that happen while the server is running you have to create a new class that handles all events.</para> +<para><programlisting role="php-highlighted">1 require_once 'myHandler.php'; +2 require_once 'Net/Server.php'; +3 +4 $server = &<link linkend="package.networking.net-server.net-server-summary">Net_Server</link>::<link linkend="package.networking.net-server.net-server.create">create</link>('fork', 'localhost', 9090); +5 +6 $handler = &new myHandler; +7 +8 $server->setCallbackObject($handler); +9 +10 $server->start(); +</programlisting></para> +<para>See Server/Handler.php for a baseclass that you can use to implement new handlers.</para> + +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server</classname></title> + <para> + <itemizedlist> + <listitem><para> + Net_Server + </para></listitem> + </itemizedlist> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server.create; +<refentry id="package.networking.net-server.net-server-driver-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Driver</classname></refname> + <refpurpose>Base class for all drivers</refpurpose> + </refnamediv> +<refsect1> + <title>Base class for all drivers</title> + ¬documented; +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Driver</classname></title> + <para> + <itemizedlist> + <listitem><para> + PEAR + <itemizedlist> + <listitem><para> + Net_Server_Driver + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + <para> + <table> + <title>Classes that extend <classname>Net_Server_Driver</classname></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class</entry> + <entry>Summary</entry> + </row> + </thead> + <tbody> + <row> + <entry><link linkend="package.networking.net-server.net-server-driver-fork-summary">Net_Server_Driver_Fork</link></entry> + <entry>Forking server class.</entry> + </row> + <row> + <entry><link linkend="package.networking.net-server.net-server-driver-sequential-summary">Net_Server_Driver_Sequential</link></entry> + <entry>Sequential server class.</entry> + </row> + </tbody> + </tgroup> + </table> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-driver.getlastsocketerror; +&package.networking.net-server.net-server-driver.setcallbackobject; +&package.networking.net-server.net-server-driver.setdebugmode; +<refentry id="package.networking.net-server.net-server-driver-fork-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Driver_Fork</classname></refname> + <refpurpose>Forking server class.</refpurpose> + </refnamediv> +<refsect1> + <title>Forking server class.</title> + <para>This class will fork a new process for each connection. This allows you to build servers, where communication between the clients is no issue.</para> +<para>Events that can be handled: +<itemizedlist> +<listitem><para>onStart</para></listitem> + +<listitem><para>onConnect</para></listitem> + +<listitem><para>onClose</para></listitem> + +<listitem><para>onReceiveData</para></listitem> +</itemizedlist></para> + +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Driver_Fork</classname></title> + <para> + <itemizedlist> + <listitem><para> + PEAR + <itemizedlist> + <listitem><para> + <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link> + <itemizedlist> + <listitem><para> + Net_Server_Driver_Fork + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + <para> + <classname>Net_Server_Driver_Fork</classname> Inherited Methods + </para> + <para> + <table> + <title>Inherited from <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Method Name</entry> + <entry>Summary</entry> + </row> + </thead> + <tbody> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.getlastsocketerror"><function>Net_Server_Driver::getLastSocketError</function></link></entry> + <entry>return string for last socket error</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setcallbackobject"><function>Net_Server_Driver::setCallbackObject</function></link></entry> + <entry>register a callback object, that is used to handle all events</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setdebugmode"><function>Net_Server_Driver::setDebugMode</function></link></entry> + <entry>set debug mode</entry> + </row> + </tbody> + </tgroup> + </table> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-driver-fork.broadcastdata; +&package.networking.net-server.net-server-driver-fork.closeconnection; +&package.networking.net-server.net-server-driver-fork.getclientinfo; +&package.networking.net-server.net-server-driver-fork.getclients; +&package.networking.net-server.net-server-driver-fork.isconnected; +&package.networking.net-server.net-server-driver-fork.senddata; +&package.networking.net-server.net-server-driver-fork.servicerequest; +&package.networking.net-server.net-server-driver-fork.setmaxclients; +&package.networking.net-server.net-server-driver-fork.shutdown; +&package.networking.net-server.net-server-driver-fork.start; +<refentry id="package.networking.net-server.net-server-driver-sequential-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Driver_Sequential</classname></refname> + <refpurpose>Sequential server class.</refpurpose> + </refnamediv> +<refsect1> + <title>Sequential server class.</title> + <para>This class will handles all connection in one server process. This allows you to build servers, where communication between the clients is easy. The drawback is that clients are served sequentially (hence the name). If you send large blocks of data to a client, the others will have to wait. For servers where communication between clients is not needed, use Net_Server_Fork instead.</para> +<para>Events that can be handled: +<itemizedlist> +<listitem><para>onStart</para></listitem> + +<listitem><para>onConnect</para></listitem> + +<listitem><para>onConnectionRefused</para></listitem> + +<listitem><para>onClose</para></listitem> + +<listitem><para>onReceiveData</para></listitem> + +<listitem><para>onShutdown</para></listitem> +</itemizedlist></para> + +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Driver_Sequential</classname></title> + <para> + <itemizedlist> + <listitem><para> + PEAR + <itemizedlist> + <listitem><para> + <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link> + <itemizedlist> + <listitem><para> + Net_Server_Driver_Sequential + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + <para> + <classname>Net_Server_Driver_Sequential</classname> Inherited Methods + </para> + <para> + <table> + <title>Inherited from <link linkend="package.networking.net-server.net-server-driver-summary"><classname>Net_Server_Driver</classname></link></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Method Name</entry> + <entry>Summary</entry> + </row> + </thead> + <tbody> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.getlastsocketerror"><function>Net_Server_Driver::getLastSocketError</function></link></entry> + <entry>return string for last socket error</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setcallbackobject"><function>Net_Server_Driver::setCallbackObject</function></link></entry> + <entry>register a callback object, that is used to handle all events</entry> + </row> + <row> + <entry> <link linkend="package.networking.net-server.net-server-driver.setdebugmode"><function>Net_Server_Driver::setDebugMode</function></link></entry> + <entry>set debug mode</entry> + </row> + </tbody> + </tgroup> + </table> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-driver-sequential.acceptconnection; +&package.networking.net-server.net-server-driver-sequential.broadcastdata; +&package.networking.net-server.net-server-driver-sequential.closeconnection; +&package.networking.net-server.net-server-driver-sequential.getclientinfo; +&package.networking.net-server.net-server-driver-sequential.getclients; +&package.networking.net-server.net-server-driver-sequential.isconnected; +&package.networking.net-server.net-server-driver-sequential.senddata; +&package.networking.net-server.net-server-driver-sequential.setmaxclients; +&package.networking.net-server.net-server-driver-sequential.shutdown; +&package.networking.net-server.net-server-driver-sequential.start; +<refentry id="package.networking.net-server.net-server-handler-summary"> + <refnamediv> + <refname>Class Summary <classname>Net_Server_Handler</classname></refname> + <refpurpose>Base class for all handlers</refpurpose> + </refnamediv> +<refsect1> + <title>Base class for all handlers</title> + ¬documented; +</refsect1> +<refsect1> +<title>Class Trees for <classname>Net_Server_Handler</classname></title> + <para> + <itemizedlist> + <listitem><para> + Net_Server_Handler + </para></listitem> + </itemizedlist> + </para> +</refsect1> +</refentry> +&package.networking.net-server.net-server-handler.onclose; +&package.networking.net-server.net-server-handler.onconnect; +&package.networking.net-server.net-server-handler.onconnectionrefused; +&package.networking.net-server.net-server-handler.onreceivedata; +&package.networking.net-server.net-server-handler.onshutdown; +&package.networking.net-server.net-server-handler.onstart; +&package.networking.net-server.net-server-handler.setserverreference; +&package.networking.net-server.constants; +</sect1> +<!-- Generated by phpDocumentor v 1.2.3 http://www.phpdoc.org --> <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -20,7 +299,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil -sgml-default-dtd-file:"../../../manual.ced" +sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil @@ -28,4 +307,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +--> \ No newline at end of file Index: peardoc/en/package/networking/net-server/constants.xml +++ peardoc/en/package/networking/net-server/constants.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.constants"> <refnamediv> <refname>Package Net_Server Constants</refname> <refpurpose>Constants defined in and used by Net_Server</refpurpose> </refnamediv> <refsect1 id="package.networking.net-server.constants.details"> <title>All Constants</title> <refsect2 id="package.networking.net-server.constants.details.server---php"> <title> Constants defined in Server.php </title> <para> <table> <title>Constants defined in Server.php</title> <tgroup cols="3"> <thead> <row> <entry>Name</entry> <entry>Value</entry> <entry>Line Number</entry> </row> </thead> <tbody> <row> <entry>NET_SERVER_ERROR_DRIVER_CORRUPT</entry> <entry>52</entry> <entry>39</entry> </row> <row> <entry>NET_SERVER_ERROR_NOT_SUPPORTED</entry> <entry>53</entry> <entry>44</entry> </row> <row> <entry>NET_SERVER_ERROR_PCNTL_REQUIRED</entry> <entry>54</entry> <entry>49</entry> </row> <row> <entry>NET_SERVER_ERROR_UNKNOWN_DRIVER</entry> <entry>51</entry> <entry>34</entry> </row> </tbody> </tgroup> </table> </para> </refsect2> </refsect1> </refentry> <!-- Generated by phpDocumentor v 1.2.3 http://www.phpdoc.org --> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/broadcastdata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/broadcastdata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.broadcastdata"> <refnamediv> <refname><function>Net_Server_Driver_Fork::broadcastData</function></refname> <refpurpose>send data to all clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::broadcastData</function></funcdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>array <parameter> <optional>$exclude = array()</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$exclude</parameter> </term> <listitem> <para> client ids to exclude </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.broadcastdata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/closeconnection.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/closeconnection.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.closeconnection"> <refnamediv> <refname><function>Net_Server_Driver_Fork::closeConnection</function></refname> <refpurpose>close the current connection</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::closeConnection</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.closeconnection.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.closeconnection.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.closeconnection.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/getclientinfo.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/getclientinfo.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.getclientinfo"> <refnamediv> <refname><function>Net_Server_Driver_Fork::getClientInfo</function></refname> <refpurpose>get current information about a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>Net_Server_Driver_Fork::getClientInfo</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.returns"> &title.returns; <para> <emphasis>returns</emphasis> information about the client </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclientinfo.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/getclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/getclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.getclients"> <refnamediv> <refname><function>Net_Server_Driver_Fork::getClients</function></refname> <refpurpose>get current amount of clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>PEAR_Error <function>Net_Server_Driver_Fork::getClients</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclients.desc"> &title.desc; <para>not possible with forking</para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.getclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/isconnected.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/isconnected.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.isconnected"> <refnamediv> <refname><function>Net_Server_Driver_Fork::isConnected</function></refname> <refpurpose>check, whether a client is still connected</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>Net_Server_Driver_Fork::isConnected</function></funcdef> <paramdef>integer <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$id</parameter> </term> <listitem> <para> client id </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.returns"> &title.returns; <para> <emphasis>returns</emphasis> true if client is connected, false otherwise </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.isconnected.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/senddata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/senddata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.senddata"> <refnamediv> <refname><function>Net_Server_Driver_Fork::sendData</function></refname> <refpurpose>send data to a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::sendData</function></funcdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>boolean <parameter> <optional>$debugData = &true;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$debugData</parameter> </term> <listitem> <para> flag to indicate whether data that is written to socket should also be sent as debug message </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.senddata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/servicerequest.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/servicerequest.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.servicerequest"> <refnamediv> <refname><function>Net_Server_Driver_Fork::serviceRequest</function></refname> <refpurpose>service the current request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::serviceRequest</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.servicerequest.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.servicerequest.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.servicerequest.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/setmaxclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/setmaxclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.setmaxclients"> <refnamediv> <refname><function>Net_Server_Driver_Fork::setMaxClients</function></refname> <refpurpose>set maximum amount of simultaneous connections</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::setMaxClients</function></funcdef> <paramdef>int <parameter>$maxClients</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.desc"> &title.desc; <para>this is not possible as each client gets its own process</para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$maxClients</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.setmaxclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/shutdown.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/shutdown.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.shutdown"> <refnamediv> <refname><function>Net_Server_Driver_Fork::shutDown</function></refname> <refpurpose>shutdown server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::shutDown</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.shutdown.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.shutdown.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.shutdown.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-fork/start.xml +++ peardoc/en/package/networking/net-server/net-server-driver-fork/start.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-fork.start"> <refnamediv> <refname><function>Net_Server_Driver_Fork::start</function></refname> <refpurpose>start the server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverFork.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Fork::start</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-fork.start.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.start.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-fork.start.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/acceptconnection.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/acceptconnection.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.acceptconnection"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::acceptConnection</function></refname> <refpurpose>accept a new connection</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>Net_Server_Driver_Sequential::acceptConnection</function></funcdef> <paramdef>resource <parameter>&$socket</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.resource; <parameter>&$socket</parameter> </term> <listitem> <para> socket that received the new connection </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.returns"> &title.returns; <para> <emphasis>returns</emphasis> internal ID of the client </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.acceptconnection.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/broadcastdata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/broadcastdata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.broadcastdata"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::broadcastData</function></refname> <refpurpose>send data to all clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::broadcastData</function></funcdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>array <parameter> <optional>$exclude = array()</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$exclude</parameter> </term> <listitem> <para> client ids to exclude </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.broadcastdata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/closeconnection.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/closeconnection.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.closeconnection"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::closeConnection</function></refname> <refpurpose>close connection to a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::closeConnection</function></funcdef> <paramdef>mixed <parameter> <optional>$id = 0</optional></parameter></paramdef> <paramdef>int <parameter>$clientID</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$id</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientID</parameter> </term> <listitem> <para> internal ID of the client </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.closeconnection.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/getclientinfo.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/getclientinfo.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.getclientinfo"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::getClientInfo</function></refname> <refpurpose>get current information about a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>Net_Server_Driver_Sequential::getClientInfo</function></funcdef> <paramdef>int <parameter>$clientId</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> ID of the client </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.returns"> &title.returns; <para> <emphasis>returns</emphasis> information about the client </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclientinfo.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/getclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/getclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.getclients"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::getClients</function></refname> <refpurpose>get current amount of clients</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>Net_Server_Driver_Sequential::getClients</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.returns"> &title.returns; <para> <emphasis>returns</emphasis> amount of clients </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.getclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/isconnected.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/isconnected.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.isconnected"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::isConnected</function></refname> <refpurpose>check, whether a client is still connected</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>Net_Server_Driver_Sequential::isConnected</function></funcdef> <paramdef>integer <parameter>$id</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$id</parameter> </term> <listitem> <para> client id </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.returns"> &title.returns; <para> <emphasis>returns</emphasis> true if client is connected, false otherwise </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.isconnected.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/senddata.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/senddata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.senddata"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::sendData</function></refname> <refpurpose>send data to a client</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::sendData</function></funcdef> <paramdef>int <parameter>$clientId</parameter></paramdef> <paramdef>string <parameter>$data</parameter></paramdef> <paramdef>boolean <parameter> <optional>$debugData = &true;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> ID of the client </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$debugData</parameter> </term> <listitem> <para> flag to indicate whether data that is written to socket should also be sent as debug message </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.senddata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/setmaxclients.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/setmaxclients.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.setmaxclients"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::setMaxClients</function></refname> <refpurpose>set maximum amount of simultaneous connections</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::setMaxClients</function></funcdef> <paramdef>int <parameter>$maxClients</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$maxClients</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.setmaxclients.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/shutdown.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/shutdown.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.shutdown"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::shutDown</function></refname> <refpurpose>shutdown server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::shutDown</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.shutdown.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.shutdown.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.shutdown.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver-sequential/start.xml +++ peardoc/en/package/networking/net-server/net-server-driver-sequential/start.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver-sequential.start"> <refnamediv> <refname><function>Net_Server_Driver_Sequential::start</function></refname> <refpurpose>start the server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriverSequential.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver_Sequential::start</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver-sequential.start.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.start.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver-sequential.start.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver/getlastsocketerror.xml +++ peardoc/en/package/networking/net-server/net-server-driver/getlastsocketerror.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver.getlastsocketerror"> <refnamediv> <refname><function>Net_Server_Driver::getLastSocketError</function></refname> <refpurpose>return string for last socket error</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriver.php'; </funcsynopsisinfo> <funcprototype> <funcdef>string <function>Net_Server_Driver::getLastSocketError</function></funcdef> <paramdef>mixed <parameter>&$fd</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>&$fd</parameter> </term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.returns"> &title.returns; <para> <emphasis>returns</emphasis> last error </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.getlastsocketerror.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver/setcallbackobject.xml +++ peardoc/en/package/networking/net-server/net-server-driver/setcallbackobject.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver.setcallbackobject"> <refnamediv> <refname><function>Net_Server_Driver::setCallbackObject</function></refname> <refpurpose>register a callback object, that is used to handle all events</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriver.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver::setCallbackObject</function></funcdef> <paramdef>object <parameter>&$object</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <parameter>&$object</parameter> </term> <listitem> <para> callback object </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setcallbackobject.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-driver/setdebugmode.xml +++ peardoc/en/package/networking/net-server/net-server-driver/setdebugmode.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-driver.setdebugmode"> <refnamediv> <refname><function>Net_Server_Driver::setDebugMode</function></refname> <refpurpose>set debug mode</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerDriver.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Driver::setDebugMode</function></funcdef> <paramdef>mixed <parameter>$debug</parameter></paramdef> <paramdef>string <parameter> <optional>$dest = "stdout"</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$debug</parameter> </term> <listitem> <para> [text|html&false;] </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$dest</parameter> </term> <listitem> <para> destination of debug message (stdout to output or filename if log should be written) </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-driver.setdebugmode.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onclose.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onclose.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onclose"> <refnamediv> <refname><function>Net_Server_Handler::onClose</function></refname> <refpurpose>onClose handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onClose</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onclose.desc"> &title.desc; <para>This handler is called, when a client disconnects from the server Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onclose.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client, in Net_Server_Fork, this is always 0 </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onclose.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onclose.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onconnect.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onconnect.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onconnect"> <refnamediv> <refname><function>Net_Server_Handler::onConnect</function></refname> <refpurpose>onConnect handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onConnect</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.desc"> &title.desc; <para>This handler is called, when a new client connects Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client, in Net_Server_Fork, this is always 0 </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnect.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onconnectionrefused.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onconnectionrefused.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onconnectionrefused"> <refnamediv> <refname><function>Net_Server_Handler::onConnectionRefused</function></refname> <refpurpose>onConnectionRefused handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onConnectionRefused</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.desc"> &title.desc; <para>This handler is called, when a new client tries to connect but is not allowed to Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onconnectionrefused.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onreceivedata.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onreceivedata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onreceivedata"> <refnamediv> <refname><function>Net_Server_Handler::onReceiveData</function></refname> <refpurpose>onReceiveData handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onReceiveData</function></funcdef> <paramdef>integer <parameter> <optional>$clientId = 0</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$data = ""</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.desc"> &title.desc; <para>This handler is called, when a client sends data to the server Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$clientId</parameter> </term> <listitem> <para> unique id of the client, in Net_Server_Fork, this is always 0 </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$data</parameter> </term> <listitem> <para> data that the client sent </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onreceivedata.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onshutdown.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onshutdown.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onshutdown"> <refnamediv> <refname><function>Net_Server_Handler::onShutdown</function></refname> <refpurpose>onShutdown handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onShutdown</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onshutdown.desc"> &title.desc; <para>This handler is called, when the server is stopped. Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onshutdown.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onshutdown.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/onstart.xml +++ peardoc/en/package/networking/net-server/net-server-handler/onstart.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.onstart"> <refnamediv> <refname><function>Net_Server_Handler::onStart</function></refname> <refpurpose>onStart handler</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::onStart</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.onstart.desc"> &title.desc; <para>This handler is called, when the server starts. Available in: <itemizedlist> <listitem><para>Net_Server_Sequential</para></listitem> <listitem><para>Net_Server_Fork</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onstart.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.onstart.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server-handler/setserverreference.xml +++ peardoc/en/package/networking/net-server/net-server-handler/setserverreference.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server-handler.setserverreference"> <refnamediv> <refname><function>Net_Server_Handler::setServerReference</function></refname> <refpurpose>set a reference to the server object</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ServerHandler.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Net_Server_Handler::setServerReference</function></funcdef> <paramdef>object Net_Server_* <parameter>&$server</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.desc"> &title.desc; <para>This is done automatically when the handler is passed over to the server</para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object Net_Server_*; <parameter>&$server</parameter> </term> <listitem> <para> object </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server-handler.setserverreference.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/networking/net-server/net-server/create.xml +++ peardoc/en/package/networking/net-server/net-server/create.xml <!-- $Revision: 1.1 $ --> <refentry id="package.networking.net-server.net-server.create"> <refnamediv> <refname><function>Net_Server::create</function></refname> <refpurpose>create a new server</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'Server.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void& <function>Net_Server::create</function></funcdef> <paramdef>string <parameter>$type</parameter></paramdef> <paramdef>string <parameter>$host</parameter></paramdef> <paramdef>integer <parameter>$port</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.networking.net-server.net-server.create.desc"> &title.desc; <para>Currently two types of servers are supported: <itemizedlist> <listitem><para>'sequential', creates a server where one process handles all request from all clients sequentially</para></listitem> <listitem><para>'fork', creates a server where a new process is forked for each client that connects to the server. This only works on *NIX</para></listitem> </itemizedlist></para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$type</parameter> </term> <listitem> <para> type of the server </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$host</parameter> </term> <listitem> <para> hostname </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$port</parameter> </term> <listitem> <para> port </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.static"> <title>static</title> <para> <emphasis>static</emphasis> </para> </refsect1> <refsect1 id="package.networking.net-server.net-server.create.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- 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: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->