ObservableProvider
JsonProvider
RemotingProvider
| Package: | CQ.Ext.direct |
| Class: | RemotingProvider |
| Extends: | CQ.Ext.direct.JsonProvider |
| Clientlib: | cq.widgets |
The RemotingProvider exposes access to server side methods on the client (a remote procedure call (RPC) type of connection where the client can initiate a procedure on the server).
This allows for code to be organized in a fashion that is maintainable, while providing a clear path between client and server, something that is not always apparent when using URLs.
To accomplish this the server-side needs to describe what classes and methods are available on the client-side. This configuration will typically be outputted by the server-side CQ.Ext.Direct stack when the API description is built.
| Config Options | Defined By | |
|---|---|---|
|
actions : Object Object literal defining the server side actions and methods. For example, if the Provider is configured with: "action...
Object literal defining the server side actions and methods. For example, if the Provider is configured with:
Note that a Store is not required, a server method can be called at any time. In the following example a client side handler is used to call the server side method "multiply" in the server-side "TestAction" Class: In the example above, the server side "multiply" function will be passed two arguments (2 and 4). The "multiply" method should return the value 8 which will be available as the result in the example above. |
RemotingProvider | |
|
enableBuffer : Number/Boolean true or false to enable or disable combining of method calls. If a number is specified this is the amount of time in ...
true or false to enable or disable combining of method calls. If a number is specified this is the amount of time in milliseconds to wait before sending a batched request (defaults to 10). Calls which are received within the specified timeframe will be concatenated together and sent in a single request, optimizing the application by reducing the amount of round trips that have to be made to the server. |
RemotingProvider | |
|
enableUrlEncode : String Specify which param will hold the arguments for the method. Defaults to 'data'.
Specify which param will hold the arguments for the method. Defaults to 'data'.
|
RemotingProvider | |
|
id : String The unique id of the provider (defaults to an auto-assigned id). You should assign an id if you need to be able to ac...
The unique id of the provider (defaults to an auto-assigned id). You should assign an id if you need to be able to access the provider later and you do not have an object reference available, for example:
|
Provider | |
|
maxRetries : Number Number of times to re-attempt delivery on failure of a call. Defaults to 1.
Number of times to re-attempt delivery on failure of a call. Defaults to 1.
|
RemotingProvider | |
|
namespace : String/Object Namespace for the Remoting Provider (defaults to the browser global scope of window). Explicitly specify the namespac...
Namespace for the Remoting Provider (defaults to the browser global scope of window). Explicitly specify the namespace Object, or specify a String to have a namespace created implicitly.
|
RemotingProvider | |
|
priority : Number Priority of the request. Lower is higher priority, 0 means "duplex" (always on). All Providers default to 1 except fo...
Priority of the request. Lower is higher priority, 0 means "duplex" (always on). All Providers default to 1 except for PollingProvider which defaults to 3.
|
Provider | |
|
timeout : Number The timeout to use for each request. Defaults to undefined.
The timeout to use for each request. Defaults to undefined.
|
RemotingProvider | |
|
type : String Required, undefined by default. The type of provider specified to CQ.Ext.Direct.addProvider to create a new Provider....
Required, undefined by default. The type of provider specified to CQ.Ext.Direct.addProvider to create a new Provider. Acceptable values by default are:
|
Provider | |
|
url : String Required. The url to connect to the CQ.Ext.Direct server-side router.
Required. The url to connect to the CQ.Ext.Direct server-side router.
|
RemotingProvider | |
| Property | Defined By | |
|---|---|---|
|
connect : Object
Abstract methods for subclasses to implement.
|
Provider | |
|
disconnect : Object
Abstract methods for subclasses to implement.
|
Provider | |
| Method | Defined By | |
|---|---|---|
enableBubble( String/Array events ) : void Enables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present....
Enables events fired by this Observable to bubble up an owner hierarchy by calling
This is commonly used by CQ.Ext.Components to bubble events to owner Containers. See CQ.Ext.Component.getBubbleTarget. The default implementation in CQ.Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example:
Parameters:
|
Observable | |
|
isConnected() : void Returns whether or not the server-side is currently connected.
Abstract method for subclasses to implement.
Returns whether or not the server-side is currently connected.
Abstract method for subclasses to implement.
Parameters:
|
Provider | |
relayEvents( Object o, Array events ) : void Relays selected events from the specified Observable as if the events were fired by this.
Relays selected events from the specified Observable as if the events were fired by this.
Parameters:
|
Observable | |
| Event | Defined By | |
|---|---|---|
beforecall : ( CQ.Ext.direct.RemotingProvider provider, CQ.Ext.Direct.Transaction transaction, Object meta ) Fires immediately before the client-side sends off the RPC call.
By returning false from an event handler you can pre...
Fires immediately before the client-side sends off the RPC call.
By returning false from an event handler you can prevent the call from
executing.
Listeners will be called with the following arguments:
|
RemotingProvider | |
call : ( CQ.Ext.direct.RemotingProvider provider, CQ.Ext.Direct.Transaction transaction, Object meta ) Fires immediately after the request to the server-side is sent. This does
NOT fire after the response has come back f...
Fires immediately after the request to the server-side is sent. This does
NOT fire after the response has come back from the call.
Listeners will be called with the following arguments:
|
RemotingProvider | |
connect : ( CQ.Ext.direct.Provider provider ) Fires when the Provider connects to the server-side
Fires when the Provider connects to the server-side
Listeners will be called with the following arguments:
|
Provider | |
data : ( CQ.Ext.direct.Provider provider, event e ) Fires when the Provider receives data from the server-side
Fires when the Provider receives data from the server-side
Listeners will be called with the following arguments:
|
Provider | |
disconnect : ( CQ.Ext.direct.Provider provider ) Fires when the Provider disconnects from the server-side
Fires when the Provider disconnects from the server-side
Listeners will be called with the following arguments:
|
Provider | |
|
exception : () Fires when the Provider receives an exception from the server-side
Fires when the Provider receives an exception from the server-side
Listeners will be called with the following arguments:
|
Provider | |