mx.rpc.AbstractService (Flex™ 2 Language Reference)

	Property	Defined by
		channelSet : ChannelSet Provides access to the ChannelSet used by the service.	AbstractService
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		destination : String The destination of the service.	AbstractService
		operations : Object The Operations array is usually only set by the MXML compiler if you create a service using an MXML tag.	AbstractService
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		requestTimeout : int Provides access to the request timeout in seconds for sent messages.	AbstractService

	Method	Defined by
		AbstractService(destination:String = null)	AbstractService
		disconnect():void Disconnects the service's network connection and removes any pending request responders.	AbstractService
		getOperation(name:String):AbstractOperation Returns an Operation of the given name.	AbstractService
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		logout():void Logs the user out of the destination.	AbstractService
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setCredentials(username:String, password:String):void Set the credentials for the destination accessed by the service.	AbstractService
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRemoteCredentials(remoteUsername:String, remotePassword:String):void The username and password to be used to authenticate a user when accessing a remote, third-party endpoint such as a webservice through a proxy or a remote object through a custom adapter.	AbstractService
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

	Method	Defined by
		callProperty(name:, ... rest): Overrides the behavior of an object property that can be called as a function.	Proxy
		deleteProperty(name:*):Boolean Overrides the request to delete a property.	Proxy
		getDescendants(name:): Overrides the use of the `descendant` operator.	Proxy
		getProperty(name:): Overrides any request for a property's value.	Proxy
		hasProperty(name:*):Boolean Overrides a request to check whether an object has a particular property by name.	Proxy
		isAttribute(name:*):Boolean Checks whether a supplied QName is also marked as an attribute.	Proxy
		nextName(index:int):String Allows enumeration of the proxied object's properties by index number to retrieve property names.	Proxy
		nextNameIndex(index:int):int Allows enumeration of the proxied object's properties by index number.	Proxy
		nextValue(index:int):* Allows enumeration of the proxied object's properties by index number to retrieve property values.	Proxy
		setProperty(name:, value:):void Overrides a call to change a property's value.	Proxy

Summary	Defined by
fault	The fault event is dispatched when a service call fails and isn't handled by the Operation itself.	AbstractService
invoke	The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.	AbstractService
result	The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.	AbstractService

Property detail

channelSet

property

channelSet:ChannelSet [read-write]

Provides access to the ChannelSet used by the service. The ChannelSet can be manually constructed and assigned, or it will be dynamically created to use the configured Channels for the destination for this service.

This property can be used as the source for data binding.

Implementation
public function get channelSet():ChannelSet
public function set channelSet(value:ChannelSet):void

destination

property

destination:String [read-write]

The destination of the service. This value should match a destination entry in the services-config.xml file.

This property can be used as the source for data binding.

Implementation
public function get destination():String
public function set destination(value:String):void

operations

property

operations:Object [read-write]

The Operations array is usually only set by the MXML compiler if you create a service using an MXML tag.

This property can be used as the source for data binding.

Implementation
public function get operations():Object
public function set operations(value:Object):void

requestTimeout

property

requestTimeout:int [read-write]

Provides access to the request timeout in seconds for sent messages. A value less than or equal to zero prevents request timeout.

This property can be used as the source for data binding.

Implementation
public function get requestTimeout():int
public function set requestTimeout(value:int):void

Constructor detail

AbstractService

()

constructor

public function AbstractService(destination:String = null)Parameters

destination:String (default = null)

Method detail

disconnect

()

method

public function disconnect():void

Disconnects the service's network connection and removes any pending request responders. This method does not wait for outstanding network operations to complete.

getOperation

()

method

public final function getOperation(name:String):AbstractOperation

Returns an Operation of the given name. If the Operation wasn't been created beforehand, it is created during this call. Operations are usually accessible by simply naming them after the service variable (myService.someOperation), but if your Operation name happens to match a defined method on the service (like setCredentials), you can use this method to get the Operation instead.

Parameters

name:String — Name of the Operation.

Returns

AbstractOperation — Operation that executes for this name.

logout

()

method

public function logout():void

Logs the user out of the destination. Logging out of a destination applies to everything connected using the same ChannelSet as specified in the server configuration. For example, if you're connected over the my-rtmp channel and you log out using one of your RPC components, anything that was connected over the same ChannelSet is logged out.

setCredentials

()

method

public function setCredentials(username:String, password:String):void

Set the credentials for the destination accessed by the service. The credentials are applied to all services connected over the same ChannelSet. Note that services that use a proxy or a third-party adapter to a remote endpoint will need to setRemoteCredentials instead.

Parameters

	`username:String` — The username for the destination.

	`password:String` — The password for the destination.

setRemoteCredentials

()

method

public function setRemoteCredentials(remoteUsername:String, remotePassword:String):void

The username and password to be used to authenticate a user when accessing a remote, third-party endpoint such as a webservice through a proxy or a remote object through a custom adapter.

Parameters

	`remoteUsername:String` — the username to pass to the remote endpoint

	`remotePassword:String` — the password to pass to the remote endpoint

Event detail

fault

event

Event object type: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

The fault event is dispatched when a service call fails and isn't handled by the Operation itself.

The FAULT event type.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`fault`	The Fault object that contains the details of what caused this event.
`message`	The Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`token`	The token that represents the call to the method. Used in the asynchronous completion token pattern.

invoke

event

Event object type: mx.rpc.events.InvokeEvent
InvokeEvent.type property = mx.rpc.events.InvokeEvent.INVOKE

The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.

The INVOKE event type.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`token`	The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.
`cancelable`	true
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`message`	The request Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

result

event

Event object type: mx.rpc.events.ResultEvent
ResultEvent.type property = mx.rpc.events.ResultEvent.RESULT

The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.

The RESULT event type.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	true, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`message`	The Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`result`	Result that the RPC call returns.
`token`	The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.

Current page: http://livedocs.adobe.com/flex/2/langref/mx/rpc/AbstractService.html

Comments

MarkEllul said on May 11, 2007 at 3:53 AM :

Could more information be given about the requestTimeout?

What happens if the service call times out? is the Fault Event called? Does nothing happen?

I am sure others apart from myself would find this useful

Thanks

smgilson said on May 14, 2007 at 12:04 PM :

When the requestTimeout is exceeded the pending call/send is faulted. This property is most useful when communicating with the server over Http, and ideally it's use should be restricted to HTTPService, WebService or RemoteObject calls. It's on DataService as well in the event that a user wanted to time out a long running fill.

In all cases, it's risky to use with non-idempotent operations (i.e. create/update/delete in DataService) because you won't know whether your request didn't make it to the server or made it to the server, got processed but the response was lost or slowed down in the network.

Set this to a higher value then the normal time it takes for a request roundtrip from their client application to the server and back.

Stephen Gilson
Flex Doc Team

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class AbstractService	Properties \| Methods \| Events

Package	mx.rpc
Class	public dynamic class AbstractService
Inheritance	AbstractService Proxy Object
Implements	IEventDispatcher
Subclasses	RemoteObject, WebService