Provide some documentation as to what each of the 4 Connection classes are for.
authorAndy Allan <gravitystorm@gmail.com>
Tue, 12 Oct 2010 15:25:05 +0000 (15:25 +0000)
committerAndy Allan <gravitystorm@gmail.com>
Tue, 12 Oct 2010 15:25:05 +0000 (15:25 +0000)
net/systemeD/halcyon/connection/AMFConnection.as
net/systemeD/halcyon/connection/OSMConnection.as
net/systemeD/halcyon/connection/XMLBaseConnection.as
net/systemeD/halcyon/connection/XMLConnection.as

index c1d25b5..6ea9bcb 100755 (executable)
@@ -7,6 +7,12 @@ package net.systemeD.halcyon.connection {
        import flash.system.Security;
        import flash.net.*;
 
+    /**
+    * AMFConnection provides read-write access to an AMF server. The read/write
+    * methods bear little resemblance to the standard OSM server XML API methods,
+    * but are similar (the same?) as that used by Potlatch 1.
+    * For a lightweight AMF server see resources/tinyamf.cgi
+    */
        public class AMFConnection extends Connection {
 
                public var readConnection:NetConnection;
index 252c4bd..c38bdc1 100644 (file)
@@ -8,7 +8,11 @@ package net.systemeD.halcyon.connection {
        import net.systemeD.halcyon.ExtendedURLLoader;
        import net.systemeD.halcyon.Globals;
 
-       // Read-only connection from local files (for Halcyon)
+    /**
+    * Read-only connection from local OSM-XML format (.osm) files.
+    * This is used by Halcyon; Potlatch 2 needs a full server connection
+    * of the type provided by XMLConnection
+    */
 
        // For a limited set of arbitrary files, invoke it like this:
        //              fo.addVariable("api","http://127.0.0.1/~richard/potlatch2");            // base URL
index 6f67b5f..dc5ae5b 100644 (file)
@@ -8,6 +8,11 @@ package net.systemeD.halcyon.connection {
 
        import net.systemeD.halcyon.Globals;
 
+    /**
+    * XMLBaseConnection is the common code between connecting to an OSM server
+    * (i.e. XMLConnection) and connecting to a standalone .osm file (i.e. OSMConnection)
+    * and so mainly concerns itself with /map -call-ish related matters
+    */
        public class XMLBaseConnection extends Connection {
 
                public function XMLBaseConnection() {
index 0c521c5..4044ad5 100644 (file)
@@ -8,6 +8,10 @@ package net.systemeD.halcyon.connection {
 
        import net.systemeD.halcyon.MapEvent;
 
+    /**
+    * XMLConnection provides all the methods required to connect to a live
+    * OSM server. See OSMConnection for connecting to a read-only .osm file
+    */
        public class XMLConnection extends XMLBaseConnection {
 
         //public var readConnection:NetConnection;