Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ServerConfig

Package | mx.messaging.config
Class | public class ServerConfig
Inheritance | ServerConfig Object

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

This class provides access to the server messaging configuration information. This class encapsulates information from the services-config.xml file on the client and is used by the messaging system to provide configured ChannelSets and Channels to the messaging framework.

The XML source is provided during the compilation process. However, there is currently no internal restriction preventing the acquisition of this XML data by other means, such as network, local file system, or shared object at runtime.

Public Properties

| Property | Defined By
--- | --- | ---
|  | xml : XML [static] The XML configuration; this value must contain the relevant portions of the <services> tag from the services-config.xml file. | ServerConfig

Public Methods

| Method | Defined By
--- | --- | ---
|  | checkChannelConsistency(destinationA:String, destinationB:String):void [static] This method ensures that the destinations specified contain identical channel definitions. | ServerConfig
|  | getChannel(id:String, clustered:Boolean = false):Channel [static] Returns a shared instance of the configured Channel. | ServerConfig
|  | getChannelSet(destinationId:String):ChannelSet [static] Returns a shared ChannelSet for use with the specified destination belonging to the service that handles the specified message type. | ServerConfig
|  | getProperties(destinationId:String):XMLList [static] Returns the property information for the specified destination | ServerConfig

Property Detail

xml | property

`xml:XML`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The XML configuration; this value must contain the relevant portions of the <services> tag from the services-config.xml file.

Implementation
`public static function get xml():XML`
`public static function set xml(value:XML):void`
Method Detail

checkChannelConsistency | () | method

`public static function checkChannelConsistency(destinationA:String, destinationB:String):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

This method ensures that the destinations specified contain identical channel definitions. If the channel definitions between the two destinations specified are not identical this method will throw an ArgumentError.

Parameters

| `destinationA:String` — first destination to compare against
| `destinationB:String` — second destination to compare channels with

getChannel | () | method |

`public static function getChannel(id:String, clustered:Boolean = false):Channel`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a shared instance of the configured Channel.

Parameters

| `id:String` — The id of the desired Channel.
| `clustered:Boolean` (default = `false`)`` — True if the Channel will be used in a clustered fashion; otherwise false.

Returns

| `Channel` — The Channel instance.

Throws

| `InvalidChannelError` — If no Channel has the specified id.

getChannelSet | () | method |

`public static function getChannelSet(destinationId:String):ChannelSet`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a shared ChannelSet for use with the specified destination belonging to the service that handles the specified message type.

Parameters

| `destinationId:String` — The target destination id.

Returns

| `ChannelSet` — The ChannelSet.

Throws

| `InvalidDestinationError` — If the specified destination does not have channels and the application did not define default channels.

getProperties | () | method |

`public static function getProperties(destinationId:String):XMLList`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the property information for the specified destination

Parameters

| `destinationId:String` — The id of the desired destination.

Returns

| `XMLList` — XMLList containing the <property> tag information.

Throws

| `InvalidDestinationError` — If the specified destination is not found.

Sun Mar 5 2017, 03:42 PM +11:00