Overview
+ * Ext.Direct aims to streamline communication between the client and server by providing a single interface that + * reduces the amount of common code typically required to validate data and handle returned data packets (reading data, + * error conditions, etc). * - *Ext.Direct aims to streamline communication between the client and server - * by providing a single interface that reduces the amount of common code - * typically required to validate data and handle returned data packets - * (reading data, error conditions, etc).
+ * The Ext.direct namespace includes several classes for a closer integration with the server-side. The Ext.data + * namespace also includes classes for working with Ext.data.Stores which are backed by data from an Ext.Direct method. * - *The Ext.direct namespace includes several classes for a closer integration - * with the server-side. The Ext.data namespace also includes classes for working - * with Ext.data.Stores which are backed by data from an Ext.Direct method.
+ * # Specification * - *Specification
+ * For additional information consult the [Ext.Direct Specification][1]. * - *For additional information consult the - * Ext.Direct Specification.
+ * # Providers * - *Providers
+ * Ext.Direct uses a provider architecture, where one or more providers are used to transport data to and from the + * server. There are several providers that exist in the core at the moment: * - *Ext.Direct uses a provider architecture, where one or more providers are - * used to transport data to and from the server. There are several providers - * that exist in the core at the moment:
A provider does not need to be invoked directly, providers are added via - * {@link Ext.direct.Manager}.{@link Ext.direct.Manager#addProvider addProvider}.
+ * # Router * - *Router
+ * Ext.Direct utilizes a "router" on the server to direct requests from the client to the appropriate server-side + * method. Because the Ext.Direct API is completely platform-agnostic, you could completely swap out a Java based server + * solution and replace it with one that uses C# without changing the client side JavaScript at all. * - *Ext.Direct utilizes a "router" on the server to direct requests from the client - * to the appropriate server-side method. Because the Ext.Direct API is completely - * platform-agnostic, you could completely swap out a Java based server solution - * and replace it with one that uses C# without changing the client side JavaScript - * at all.
+ * # Server side events * - *Server side events
+ * Custom events from the server may be handled by the client by adding listeners, for example: + * + * {"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"} + * + * // add a handler for a 'message' event sent by the server + * Ext.direct.Manager.on('message', function(e){ + * out.append(String.format('{0}
', e.data)); + * out.el.scrollTo('t', 100000, true); + * }); + * + * [1]: http://sencha.com/products/extjs/extdirect * - *Custom events from the server may be handled by the client by adding - * listeners, for example:
- *
-{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
-
-// add a handler for a 'message' event sent by the server
-Ext.direct.Manager.on('message', function(e){
- out.append(String.format('<p><i>{0}</i></p>', e.data));
- out.el.scrollTo('t', 100000, true);
-});
- *
-var pollProv = new Ext.direct.PollingProvider({
- url: 'php/poll2.php'
-});
-Ext.direct.Manager.addProvider({
- "type":"remoting", // create a {@link Ext.direct.RemotingProvider}
- "url":"php\/router.php", // url to connect to the Ext.Direct server-side router.
- "actions":{ // each property within the actions object represents a Class
- "TestAction":[ // array of methods within each server side Class
- {
- "name":"doEcho", // name of method
- "len":1
- },{
- "name":"multiply",
- "len":1
- },{
- "name":"doForm",
- "formHandler":true, // handle form on server with Ext.Direct.Transaction
- "len":1
- }]
- },
- "namespace":"myApplication",// namespace to create the Remoting Provider in
-},{
- type: 'polling', // create a {@link Ext.direct.PollingProvider}
- url: 'php/poll.php'
-}, pollProv); // reference to previously created instance
- *