[Gnash-commit] gnash ./ChangeLog doc/C/netconnection.xml

[Rob Savoye]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         
Changes by:     Rob Savoye <address@hidden>     06/02/04 07:51:34

Modified files:
        .              : ChangeLog 
        doc/C          : netconnection.xml 

Log message:
        * doc/C/netconnection.xml: Update with more detailed data on this
        class.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/ChangeLog.diff?tr1=1.80&tr2=1.81&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/doc/C/netconnection.xml.diff?tr1=1.2&tr2=1.3&r1=text&r2=text

Patches:
Index: gnash/ChangeLog
diff -u gnash/ChangeLog:1.80 gnash/ChangeLog:1.81
--- gnash/ChangeLog:1.80        Sat Feb  4 07:12:56 2006
+++ gnash/ChangeLog     Sat Feb  4 07:51:34 2006
@@ -1,5 +1,8 @@
 2006-02-04  Rob Savoye  <address@hidden>
 
+       * doc/C/netconnection.xml: Update with more detailed data on this
+       class.
+
        * server/NetConnection.cpp: Implement part of the connect()
        method. Add C++ accessor methods as AS methods, and we can call
        our custom methods from testing code to examine the internal state
Index: gnash/doc/C/netconnection.xml
diff -u gnash/doc/C/netconnection.xml:1.2 gnash/doc/C/netconnection.xml:1.3
--- gnash/doc/C/netconnection.xml:1.2   Tue Jan 31 02:52:59 2006
+++ gnash/doc/C/netconnection.xml       Sat Feb  4 07:51:34 2006
@@ -2,18 +2,49 @@
   <title>NetConnection ActionScript Class</title>
 
   <para>
-    This class implements an NetConnection object.
+    This class implements an NetConnection object. The NetConnection
+    object opens a client connection to load an FLV video file from a
+    local system. or a remote one using the RTMP or RTMPT protocols.
+    RTMP connections use port 1935, and RTMPT connections use port 80.
+  </para>
+
+  <para>
+    This class was first introduced for swf v7. and the behaviour has
+    recently changed slightly to allow the loading of files from
+    external systems. Prior to this, it was required to pass NULL to
+    this class. Gnash handles both cases. The older behaviour default
+    is connecting to the local filesystem for the file.
+  </para>
+
+  <para>
+    The URL that can be passed to <code>connect()</code> in newer
+    versions of the swf format is as follows:
+    <programlisting>
+      protocol:[//host][:port]/appname/[instanceName]
+    </programlisting>
+    For protocol, specify either <code>RTMP</code> or
+    <code>RTMPT</code>. If rtmp is specified, Flash Player will create
+    a client connection. If <code>RTMPT</code> is specified, Flash
+    Player will create an HTTP "tunneling" connection to the server.
+  </para>
+
+  <para>
+    You can omit the host parameter if the Flash movie is served from
+    localhost. If the instanceName parameter is omitted, Flash Player
+    connects to the application's default instance (_definst_).
   </para>
 
     <sect5 id="netconnectionmethods">
        <title>The Methods of the  Class</title>
+
        <para>
            <variablelist>
-
-               <varlistentry>
-                   <term>NetConnection.connect()</term>
+               <varlistentry>the same host where Flash Communication Server is 
installed
+                   <term>NetConnection.connect(const char *)</term>
                    <listitem>
                    <para>
+                     Connect to a local or remote system to load a
+                     FLV file. Arg can be NULL, or an URL.
                    </para>
                    </listitem>
            </varlistentry>
@@ -54,7 +85,11 @@
              </entry>
              <entry valign="top" align="center">
                <para>
-                 This method has an unknown status.
+                 This method is paritally implemented. It can only be
+                 used in conjunction with the <link
+                 linkend="asnetstream">NetStream</link> and <link
+                 linkend="asvideo">Video</link> classes, it cannot
+                 load a FLV file by itself.
                </para>
              </entry>
            </row>