Date: Mon Feb 18 07:03:56 CET 2002
User: Dan Kalowsky
Directory: srmdoc/user
Log Message:
[1.11]
- Updated some of the text
Modified files:
srmdoc/user/classes.xml (version: 1.4)
[FILE: /srmdoc/user/classes.xml]
--- srmdoc/user/classes.xml:1.3 Sun Feb 17 22:40:40 2002 GMT
+++ srmdoc/user/classes.xml Mon Feb 18 05:03:56 2002 GMT
@@ -37,7 +37,7 @@
<para>
The <classname>SRM</classname> class maintains the connection with the
- Deamon. It also manages <link linkend="class.srm.global-vars">global
+ daemon. It also manages <link linkend="class.srm.global-vars">global
variables</link> and an interface to the <link
linkend="class.srm.module-functions">functions</link> in the
extension modules.
@@ -51,12 +51,13 @@
<methodparam><type>int</type><parameter>port</parameter></methodparam>
</methodsynopsis>
<para>
- The constructor of this class connects the script to the SRM Daemon. There
- are two parameters involved; the <parameter>host</parameter> parameter is
- the IP address of the machine on which the SRM Daemon runs. The second
- parameter is the <parameter>port</parameter> on which the SRM Daemon to
- which you want to connect listens for incoming requests. The example below
- makes a connection to an SRM Daemon on the same
+ The class constructor connects the script to the SRM daemon. There
+ are two parameters necessary for this to be accomplished. The
+ <parameter>host</parameter> parameter is the IP address of the machine
+ where the SRM daemon is running. The second parameter is the
+ <parameter>port</parameter> on which the specificed SRM daemon is
+ listening for incoming connection requests. The example below
+ makes a connection to an SRM daemon on the same
<parameter>host</parameter>, running on <parameter>port</parameter> 7777
(the default port).
</para>
@@ -73,10 +74,11 @@
<refsect2 id="class.srm.global-vars">
<title>Global variables</title>
<para>
- The <classname>SRM</classname> class can also be used to manage global
- variables. Those variables are stored in the SRM Daemon, and are
- accessible by every script connection to the daemon. You can access those
- global variables with the <varname>globals</varname> array. The example
+ The <classname>SRM</classname> class is capable of managing global
+ variables for an application. These global variables are stored within
+ the SRM daemon, and are accessible to every script connected to the
+ daemon. It's possible to access the global variables with the
+ <varname>globals</varname> array found within the SRM object. The example
below shows how to set and get these variables.
</para>
<para>
@@ -96,31 +98,6 @@
</para>
</refsect2>
- <refsect2 id="class.srm.module-functions">
- <title>Functions</title>
- <para>
- The <classname>SRM</classname> class can also be used to manage global
- variables. Those variables are stored in the SRM Daemon, and are
- accessible by every script connection to the daemon. You can access those
- global variables with the <varname>globals</varname> array. The example
- below shows how to set and get these variables.
- </para>
- <para>
- <example>
- <title>Using global variables</title>
- <programlisting><?php
- /* make a connection to the daemon */
- $con = new SRM ('localhost', 7777);
-
- /* set the global variable 'foo' to 807 */
- $con->globals['foo'] = 807;
-
- /* display the contents of global variable 'bar' */
- echo $con->globals['bar'];
- ?></programlisting>
- </example>
- </para>
- </refsect2>
</refsect1>
</refentry>
@@ -171,10 +148,9 @@
</classsynopsis>
<para>
- The Class <classname>SRMApp</classname> is used to work with remote
- objects. After you instantiate the class, you can work with the object on
- the remote daemon exactly as you would do if the object was instatiated in
- a normal script.
+ The class <classname>SRMApp</classname> is able to work with remote
+ objects. After instantiating the class, it is possible to interact with a
+ remote object exactly like if the object was instatiated in a local script.
</para>
<refsect2>
@@ -187,16 +163,18 @@
</methodsynopsis>
<para>
The <parameter>srm</parameter> is an <classname>SRM</classname> object as
- returned by <literal>$obj = new SRM()</literal>. The
- <parameter>application_id</parameter> is the name of the
- <classname>Banana</classname> you want to use remotely. This remote
- <classname>Banana</classname> will be started if it was not started
- before and the handle to this <classname>Banana</classname> is stored in
- the object property <varname>handle</varname>. If the
+ returned by the constructor like so: <literal>$obj = new SRM()</literal>.
+ The <parameter>application_id</parameter> is the name of the
+ <classname>Banana</classname> desired to be accessed remotely. The
+ <classname>Banana</classname> will be started if one was not already
+ started. The handle to a <classname>Banana</classname> is stored in
+ the object property <varname>handle</varname>. If a
<classname>Banana</classname> was already running, only the handle is
- returned. In both cases this constructor returns an
- <classname>SRMApp</classname> object that can be used in the script.
+ returned. In both cases this constructor returns an
+ <classname>SRMApp</classname> object that can be used within the script.
</para>
+ <!-- What name are we going with ?!?!?! Lets decide is it an SRMApp or
+ is it a Banana? Work with me people! -Dan -->
</refsect2>
<refsect2>
@@ -206,20 +184,19 @@
<type>int</type><varname>handle</varname>
</fieldsynopsis>
<para>
- This property helds the handle to the remote
- <classname>Banana</classname>. This property should never be changed, and
- can only be used read-only, but I can't see any reason for the usage of
- this property. It might go away when the extension is ported over to
- ZendEngine 2.
+ This property contains a unique identifier to the remote
+ <classname>Banana</classname>. This property should never be altered by a
+ user, and should be considered read-only. In the future, the handle
+ system might go away when the extension is ported over to ZendEngine 2.
</para>
<fieldsynopsis>
<type>mixed</type><varname>varname</varname>
</fieldsynopsis>
<para>
- Other properties you use with this object, are handled like normal
- properties to a normal PHP Class. In the example below you can see the
- difference between a local class, and a remote
+ Other properties may be used with this object, and are handled like
+ standard properties to a generic PHP Class. The example below shows
+ the difference between a local class, and a remote
<classname>Banana</classname> class.
</para>
<para>
@@ -249,14 +226,15 @@
</methodsynopsis>
<para>
- The <function>__abort</function> member function aborts a remote
- <classname>Banana</classname>. Aborting a <classname>Banana</classname>
- means that the execution of the <classname>Banana</classname>'s eventloop
- is ended and thus the <function>run</function> member function of the
- <classname>Banana</classname> returns. You can use this function to force
- the <classname>Banana</classname> to be reloaded from disk. When you
- instantiate a aborted <classname>Banana</classname> with new
- <function>SRMApp</function> it is reloaded.
+ The <function>__abort</function> member function causes a remote
+ <classname>Banana</classname> to stop executing. This forces a
+ <classname>Banana</classname>'s eventloop to end, returning a value to the
+ <function>run</function> member function of the
+ <classname>Banana</classname>. This function can be used to force
+ a <classname>Banana</classname> to be reloaded from a disk. To reload
+ an aborted <classname>Banana</classname>, creating a new
+ <function>SRMApp</function> will cause the SRM daemon to re-read the
+ script from disk.
</para>
<methodsynopsis>
@@ -267,9 +245,9 @@
</methodsynopsis>
<para>
- As with properties to the <classname>SRMApp</classname> objects, you can
- use functions in the same way. The example below shows calling an
- function of the remote class.
+ As with properties to the <classname>SRMApp</classname> objects,
+ functions work the same way. The example below shows how to call a
+ function of a remote class.
</para>
<para>
<example>
@@ -311,11 +289,12 @@
</classsynopsis>
<para>
- The <classname>Banana</classname> is a virtual class, you should never
- make an instantiation of this class, but you should always make an
- inherited class. See the <link linkend="user.bananas.writing">Writing
- Banana components</link> section of the manual for examples and more
- information.
+ A <classname>Banana</classname> is a virtual class that should never
+ be directly instantiated. Instead any use of a
+ <classname>Banana</classname> should be done through an inherited class.
+ See the <link linkend="user.bananas.writing">Writing
+ Banana components</link> section of the manual for more information
+ and examples.
</para>
<refsect2>
@@ -327,11 +306,11 @@
</methodsynopsis>
<para>
- The <classname>Banana</classname> has only one member function, which
- initializes the eventloop of the <classname>Banana</classname>. The
- eventloop dispatches requests made to the <classname>Banana</classname>
- from the client. See <link linkend="user.bananas.eventloop">The eventloop
- of Bananas</link> for more information and examples.
+ A <classname>Banana</classname> has only one member function, which
+ initializes the eventloop. The eventloop dispatches requests made to
+ the <classname>Banana</classname> from the client. See
+ <link linkend="user.bananas.eventloop">The eventloop of Bananas</link>
+ section of the manual for more information and examples.
</para>
</refsect2>
</refsect1>
Received on Mon Feb 18 06:56:22 2002
This archive was generated by hypermail 2.1.8 : Tue Jan 06 2009 - 09:00:03 CET