View source

class ServerConfig

package feathers.messaging.config

@:directlyUsed@:access(feathers.messaging.MessageAgent)

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.

Static variables

@:value("type")staticfinalread onlyCLASS_ATTR:String = "type"

Channel config parsing constant.

@:value("uri")staticfinalread onlyURI_ATTR:String = "uri"

Channel config parsing constant.

@:value(ChannelSet)staticchannelSetFactory:Class<ChannelSet> = ChannelSet

A Class factory to use to generate auto-instantiated ChannelSet instances as is done in getChannelSet(String). Default factory is the base ChannelSet class.

staticserverConfigData:Xml

The server configuration data.

@:flash.propertystaticxml:Xml

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

Static methods

staticcheckChannelConsistency(destinationA:String, destinationB:String):Void

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.

@throw ArgumentError if the channel definitions of the specified destinations aren't identical.

Parameters:

destinationA:String

first destination to compare against

destinationB:String

second destination to compare channels with

@:value({ clustered : false })staticgetChannel(id:String, clustered:Bool = false):Channel

Returns a shared instance of the configured Channel.

Parameters:

id

The id of the desired Channel.

clustered

True if the Channel will be used in a clustered fashion; otherwise false.

Returns:

The Channel instance.

Throws:

mx.messaging.errors.InvalidChannelError

If no Channel has the specified id.

staticgetChannelSet(destinationId:String):ChannelSet

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

Parameters:

destinationId

The target destination id.

Returns:

The ChannelSet.

Throws:

mx.messaging.errors.InvalidDestinationError

If the specified destination does not have channels and the application did not define default channels.

staticgetProperties(destinationId:String):Array<Xml>

Returns the property information for the specified destination

Parameters:

destinationId

The id of the desired destination.

Returns:

XMLList containing the<property> tag information.

Throws:

mx.messaging.errors.InvalidDestinationError

If the specified destination is not found.