[royale-docs] branch master updated: update RemoteObject docs

[ca...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

carlosrovira pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git


The following commit(s) were added to refs/heads/master by this push:
     new 8faf40d  update RemoteObject docs
8faf40d is described below

commit 8faf40d842bddf17395f7c65c56ba86986dec650
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Wed Dec 25 12:52:28 2019 +0100

    update RemoteObject docs
---
 assets/images/RemoteObjectExample_2.png        | Bin 0 -> 40465 bytes
 features/loading-external-data/remoteobject.md |  37 +++++++++++++++++++++++--
 2 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/assets/images/RemoteObjectExample_2.png b/assets/images/RemoteObjectExample_2.png
new file mode 100644
index 0000000..0729667
Binary files /dev/null and b/assets/images/RemoteObjectExample_2.png differ
diff --git a/features/loading-external-data/remoteobject.md b/features/loading-external-data/remoteobject.md
index 6c701c9..6872eb7 100644
--- a/features/loading-external-data/remoteobject.md
+++ b/features/loading-external-data/remoteobject.md
@@ -38,7 +38,7 @@ In Apache Royale we have two RemoteObject implementations:
 
 ## Example of use
 
-In Apache Royale you can write a RemoteObject in the following way:
+In Apache Royale you can write an `mx:RemoteObject` in the following way:
 
 ```mxml
 <fx:Declarations>
@@ -48,6 +48,17 @@ In Apache Royale you can write a RemoteObject in the following way:
 </fx:Declarations>
 ```
 
+You can write the `Network` implementation in the following way:
+
+```mxml
+<js:beads>
+    <js:RemoteObject id="service"
+        endPoint = "http://localhost:8080/messagebroker/websocket-amf"
+        destination = "exampleService"
+        result="onResult(event)" fault="onFault(event)"/>
+</js:beads>
+```
+
 Don't forget to add the ClassAliasBead to the Application level beads:
 
 ```mxml
@@ -68,8 +79,17 @@ registerClassAlias('org.apache.royale.collections.ArrayList', ArrayList);
 
 RemoteObject in Apache Royale is very near to the Flex implementation and is working in some production applications migrated from Flex:
 
-- Small Messages are supported too, so you can rely on that Apache Flex BlazeDS implementation.
-- Vector and Dictionary in Apache Royale AMF implementation is still not supported.
+- **About Small Messages**: Apache Flex BlazeDS use by default special extra serialization through small messages. Small Messages are supported in Apache Royale implementation so you can left it on by default:
+
+```xml
+    <channel-definition ...>
+        <properties>
+            <serialization>
+                <enable-small-messages>true</enable-small-messages>
+            </serialization>
+```
+
+- **AMF Types not implemented yet**: Vector and Dictionary in Apache Royale AMF implementation is still not supported.
 
 ## Example projects available in Apache Royale
 
@@ -95,3 +115,14 @@ To run this example localy you can follow this steps. Note: At this time some pa
 
 {:align="center"}
 ![Apache Royale communication with AMF and RemoteObject Example](assets/images/RemoteObjectExample_1.jpeg)
+
+## CompressedRemoteObject
+
+A new RemoteObject, called CompressedRemoteObject, that performs compression has been added to Apache Royale. RemoteObjectAMFTest client and SampleAmfWebApp application has been updated to show this new feature. This remote object compress the AMF data with the zlib algorithm to improve the transfer times even more.
+
+{:align="center"}
+![CompressedRemoteObject Example](assets/images/RemoteObjectExample_2.png)
+
+## SimpleRemoteObject
+
+For more simple AMF backends probably RemoteObject will be more than you need. For this reason you can use SimpleRemoteObject that doesn't care about "clientId", or other BlazeDS functionalities.