Observable Provider JsonProvider RemotingProvider
Package: | Ext.direct |
Defined In: | RemotingProvider.js |
Class: | RemotingProvider |
Extends: | JsonProvider |
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 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'. | 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 | |
listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
is usually only done when extra value can be added. For example the DataView's
| Observable | |
maxRetries : Number 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. | RemotingProvider | |
type : String Required, undefined by default. The type of provider specified
to Ext.Direct.addProvider to create a
new Provider. A... Required, undefined by default. The type of provider specified
to Ext.Direct.addProvider to create a
new Provider. Acceptable values by default are:
| Provider | |
url : String Required. The url to connect to the 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 | |
---|---|---|
addEvents( Object|String o , string Optional. )
:
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
enableBubble( String/Array events )
:
voidEnables 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 Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in 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 | |
fireEvent( String eventName , Object... args )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | |
hasListener( String eventName )
:
BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event 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 | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
purgeListeners()
:
void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
:
voidRelays 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 | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
resumeEvents()
:
void Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
beforecall :
( Ext.direct.RemotingProvider provider , 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 :
( Ext.direct.RemotingProvider provider , 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 :
( 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 :
( 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 :
( 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 |