Channel

Paket	mx.messaging
Klass	public class Channel
Arv	Channel EventDispatcher Object
Implementerar	IMXMLObject
Underklasser	PollingChannel

Språkversion:

ActionScript 3.0

Produktversioner:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

The Channel class is the base message channel class that all channels in the messaging system must extend.

Channels are specific protocol-based conduits for messages sent between MessageAgents and remote destinations. Preconfigured channels are obtained within the framework using the ServerConfig.getChannel() method. You can create a Channel directly using the new operator and add it to a ChannelSet directly.

Channels represent a physical connection to a remote endpoint. Channels are shared across destinations by default. This means that a client targetting different destinations may use the same Channel to communicate with these destinations.

Note: This class is for advanced use only. Use this class for creating custom channels like the existing RTMPChannel, AMFChannel, and HTTPChannel.

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		authenticated : Boolean [skrivskyddad] Indicates if this channel is authenticated.	Channel
		channelSets : Array [skrivskyddad] Provides access to the ChannelSets connected to the Channel.	Channel
		connected : Boolean [skrivskyddad] Indicates whether this channel has established a connection to the remote destination.	Channel
		connectTimeout : int Provides access to the connect timeout in seconds for the channel.	Channel
		constructor : Object En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	Object
		endpoint : String [skrivskyddad] Provides access to the endpoint for this channel.	Channel
		failoverURIs : Array Provides access to the set of endpoint URIs that this channel can attempt to failover to if the endpoint is clustered.	Channel
		id : String Provides access to the id of this channel.	Channel
		protocol : String [skrivskyddad] Provides access to the protocol that the channel uses.	Channel
		reconnecting : Boolean [skrivskyddad] Indicates whether this channel is in the process of reconnecting to an alternate endpoint.	Channel
		recordMessageSizes : Boolean [skrivskyddad] Channel property determines the level of performance information injection - whether we inject message sizes or not.	Channel
		recordMessageTimes : Boolean [skrivskyddad] Channel property determines the level of performance information injection - whether we inject timestamps or not.	Channel
		requestTimeout : int Provides access to the default request timeout in seconds for the channel.	Channel
		uri : String Provides access to the URI used to create the whole endpoint URI for this channel.	Channel

Skyddade egenskaper

	Egenskap		Definieras med
		shouldBeConnected : Boolean [skrivskyddad] Indicates whether this channel should be connected to its endpoint.	Channel

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		Channel(id:String = null, uri:String = null) Constructs an instance of a generic Channel that connects to the specified endpoint URI.	Channel
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.	EventDispatcher
		applySettings(settings:XML):void Subclasses should override this method to apply any settings that may be necessary for an individual channel.	Channel
		connect(channelSet:ChannelSet):void Connects the ChannelSet to the Channel.	Channel
		disconnect(channelSet:ChannelSet):void Disconnects the ChannelSet from the Channel.	Channel
		dispatchEvent(event:Event):Boolean Skickar en händelse till händelseflödet.	EventDispatcher
		hasEventListener(type:String):Boolean Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.	EventDispatcher
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	Object
		isPrototypeOf(theClass:Object):Boolean Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.	Object
		logout(agent:MessageAgent):void Sends a CommandMessage to the server to logout if the Channel is connected.	Channel
		propertyIsEnumerable(name:String):Boolean Anger om den angivna egenskapen finns och är uppräkningsbar.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		send(agent:MessageAgent, message:IMessage):void Sends the specified message to its target destination.	Channel
		setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void Sets the credentials to the specified value.	Channel
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	Object
		toLocaleString():String Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object
		willTrigger(type:String):Boolean Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.	EventDispatcher

Skyddade metoder

	Metod		Definieras med
		applyClientLoadBalancingSettings(props:XML):void Applies the client load balancing urls if they exists.	Channel
		connectFailed(event:ChannelFaultEvent):void Processes a failed internal connect and dispatches the FAULT event for the channel.	Channel
		connectSuccess():void Processes a successful internal connect and dispatches the CONNECT event for the Channel.	Channel
		connectTimeoutHandler(event:flash.events:TimerEvent):void Handles a connect timeout by dispatching a ChannelFaultEvent.	Channel
		disconnectFailed(event:ChannelFaultEvent):void Processes a failed internal disconnect and dispatches the FAULT event for the channel.	Channel
		disconnectSuccess(rejected:Boolean = false):void Processes a successful internal disconnect and dispatches the DISCONNECT event for the Channel.	Channel
		flexClientWaitHandler(event:PropertyChangeEvent):void Handles a change to the guard condition for managing initial Channel connect for the application.	Channel
		getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder Returns the appropriate MessageResponder for the Channel's send() method.	Channel
		internalConnect():void Connects the Channel to its endpoint.	Channel
		internalDisconnect(rejected:Boolean = false):void Disconnects the Channel from its endpoint.	Channel
		internalSend(messageResponder:MessageResponder):void Sends the Message out over the Channel and routes the response to the responder.	Channel

Händelser

Klicka för mer information om händelser

Dölj ärvda händelser

Visa ärvda händelser

	Sammanfattning	Definieras med
activate	[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.	EventDispatcher
channelConnect	Dispatched after the channel has connected to its endpoint.	Channel
channelDisconnect	Dispatched after the channel has disconnected from its endpoint.	Channel
channelFault	Dispatched after the channel has faulted.	Channel
deactivate	[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.	EventDispatcher
message	Dispatched when a channel receives a message from its endpoint.	Channel
propertyChange	Dispatched when a property of the channel changes.	Channel

Skyddade konstanter

	Konstant		Definieras med
		CONNECT_TIMEOUT_SECONDS : String = "connect-timeout-seconds" [statisk]	Channel
		ENABLE_SMALL_MESSAGES : String = "enable-small-messages" [statisk]	Channel
		FALSE : String = "false" [statisk]	Channel
		RECORD_MESSAGE_SIZES : String = "record-message-sizes" [statisk]	Channel
		RECORD_MESSAGE_TIMES : String = "record-message-times" [statisk]	Channel
		REQUEST_TIMEOUT_SECONDS : String = "request-timeout-seconds" [statisk]	Channel
		SERIALIZATION : String = "serialization" [statisk]	Channel
		TRUE : String = "true" [statisk]	Channel

Egenskapsdetaljer

authenticated

egenskap

authenticated:Boolean [skrivskyddad]

Indicates if this channel is authenticated.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen propertyChange .

Implementering
public function get authenticated():Boolean

endpoint

egenskap

endpoint:String [skrivskyddad]

Provides access to the endpoint for this channel. This value is calculated based on the value of the uri property.

Implementering
public function get endpoint():String

failoverURIs

egenskap

failoverURIs:Array

Provides access to the set of endpoint URIs that this channel can attempt to failover to if the endpoint is clustered.

This property is automatically populated when clustering is enabled. If you don't use clustering, you can set your own values.

Implementering
public function get failoverURIs():Array
public function set failoverURIs(value:Array):void

id

egenskap

id:String

Provides access to the id of this channel.

Implementering
public function get id():String
public function set id(value:String):void

protocol

egenskap

protocol:String [skrivskyddad]

Provides access to the protocol that the channel uses.

Note: Subclasses of Channel must override this method and return a string that represents their supported protocol. Examples of supported protocol strings are "rtmp", "http" or "https".

Implementering
public function get protocol():String

reconnecting

egenskap

reconnecting:Boolean [skrivskyddad]

Indicates whether this channel is in the process of reconnecting to an alternate endpoint.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen propertyChange .

Implementering
public function get reconnecting():Boolean

requestTimeout

egenskap

requestTimeout:int

Provides access to the default request timeout in seconds for the channel. A value of 0 or below indicates that outbound requests will never be timed out on the client.

Request timeouts are most useful for RPC style messaging that requires a response from the remote destination.

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

shouldBeConnected

egenskap

shouldBeConnected:Boolean [skrivskyddad]

Indicates whether this channel should be connected to its endpoint. This flag is used to control when fail over should be attempted and when disconnect notification is sent to the remote endpoint upon disconnect or fault.

Implementering
protected function get shouldBeConnected():Boolean

uri

egenskap

uri:String

Provides access to the URI used to create the whole endpoint URI for this channel. The URI can be a partial path, in which case the full endpoint URI is computed as necessary.

Implementering
public function get uri():String
public function set uri(value:String):void

Konstruktordetaljer

Metoddetaljer

applyClientLoadBalancingSettings

()

metod

protected function applyClientLoadBalancingSettings(props:XML):void

Applies the client load balancing urls if they exists. It randomly picks a url from the set of client load balancing urls and sets it as the channel's main url; then it assigns the rest of the urls as the failoverURIs of the channel.

Parametrar

props:XML — The properties section of the XML fragment of the services-config.xml file for this channel.

applySettings

()

metod

public function applySettings(settings:XML):void

Subclasses should override this method to apply any settings that may be necessary for an individual channel. Make sure to call super.applySettings() to apply common settings for the channel. This method is used primarily in Channel subclasses.

Parametrar

settings:XML — XML fragment of the services-config.xml file for this channel.

connect

()

metod

public final function connect(channelSet:ChannelSet):void

Connects the ChannelSet to the Channel. If the Channel has not yet connected to its endpoint, it attempts to do so. Channel subclasses must override the internalConnect() method, and call the connectSuccess() method once the underlying connection is established.

Parametrar

channelSet:ChannelSet — The ChannelSet to connect to the Channel.

connectFailed

()

metod

protected function connectFailed(event:ChannelFaultEvent):void

Processes a failed internal connect and dispatches the FAULT event for the channel. If the Channel has failoverURI values, it will attempt to reconnect automatically by trying these URI values in order until a connection is established or the available values are exhausted.

Parametrar

event:ChannelFaultEvent — The ChannelFaultEvent for the failed connect.

connectSuccess

()

metod

protected function connectSuccess():void

Processes a successful internal connect and dispatches the CONNECT event for the Channel.

connectTimeoutHandler

()

metod

protected function connectTimeoutHandler(event:flash.events:TimerEvent):void

Handles a connect timeout by dispatching a ChannelFaultEvent. Subtypes may overide this to shutdown the current connect attempt but must call super.connectTimeoutHandler(event).

Parametrar

event:flash.events:TimerEvent — The timer event indicating that the connect timeout has been reached.

disconnect

()

metod

public final function disconnect(channelSet:ChannelSet):void

Disconnects the ChannelSet from the Channel. If the Channel is connected to its endpoint and it has no more connected ChannelSets it will internally disconnect.

Channel subclasses need to override the internalDisconnect() method, and call the disconnectSuccess() method when the underlying connection has been terminated.

Parametrar

channelSet:ChannelSet — The ChannelSet to disconnect from the Channel.

disconnectFailed

()

metod

protected function disconnectFailed(event:ChannelFaultEvent):void

Processes a failed internal disconnect and dispatches the FAULT event for the channel.

Parametrar

event:ChannelFaultEvent — The ChannelFaultEvent for the failed disconnect.

disconnectSuccess

()

metod

protected function disconnectSuccess(rejected:Boolean = false):void

Processes a successful internal disconnect and dispatches the DISCONNECT event for the Channel. If the disconnect is due to a network failure and the Channel has failoverURI values, it will attempt to reconnect automatically by trying these URI values in order until a connection is established or the available values are exhausted.

Parametrar

rejected:Boolean (default = false) — True if the disconnect should skip any failover processing that would otherwise be attempted; false if failover processing should be allowed to run.

flexClientWaitHandler

()

metod

protected function flexClientWaitHandler(event:PropertyChangeEvent):void

Handles a change to the guard condition for managing initial Channel connect for the application. When this is invoked it means that this Channel is waiting to attempt to connect.

Parametrar

event:PropertyChangeEvent — The PropertyChangeEvent dispatched by the FlexClient singleton.

getMessageResponder

()

metod

protected function getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder

Returns the appropriate MessageResponder for the Channel's send() method. Must be overridden.

Parametrar

	`agent:MessageAgent` — The MessageAgent sending the message.

	`message:IMessage` — The Message to send.

Returnerar

MessageResponder — The MessageResponder to handle the result or fault.

Utlöser

IllegalOperationError — If the Channel subclass does not override this method.

internalConnect

()

metod

protected function internalConnect():void

Connects the Channel to its endpoint. Must be overridden.

internalDisconnect

()

metod

protected function internalDisconnect(rejected:Boolean = false):void

Disconnects the Channel from its endpoint. Must be overridden.

Parametrar

rejected:Boolean (default = false) — True if the disconnect was due to a connection rejection or timeout and reconnection should not be attempted automatically; otherwise false.

internalSend

()

metod

protected function internalSend(messageResponder:MessageResponder):void

Sends the Message out over the Channel and routes the response to the responder. Must be overridden.

Parametrar

messageResponder:MessageResponder — The MessageResponder to handle the response.

logout

()

metod

public function logout(agent:MessageAgent):void

Sends a CommandMessage to the server to logout if the Channel is connected. Current credentials are cleared.

Parametrar

agent:MessageAgent — The MessageAgent to logout.

send

()

metod

public function send(agent:MessageAgent, message:IMessage):void

Sends the specified message to its target destination. Subclasses must override the internalSend() method to perform the actual send.

Parametrar

	`agent:MessageAgent` — The MessageAgent that is sending the message.

	`message:IMessage` — The Message to send.

Utlöser

InvalidDestinationError — If neither the MessageAgent nor the message specify a destination.

setCredentials

()

metod

public function setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void

Sets the credentials to the specified value. If the credentials are non-null and the Channel is connected, this method also sends a CommandMessage to the server to login using the credentials.

Parametrar

	`credentials:String` — The credentials string.

	`agent:MessageAgent` (default = `null`) — The MessageAgent to login, that will handle the login result.

	`charset:String` (default = `null`) — The character set encoding used while encoding the credentials. The default is null, which implies the legacy charset of ISO-Latin-1.

Utlöser

IllegalOperationError — in two situations; if credentials have already been set and an authentication is in progress with the remote detination, or if authenticated and the credentials specified don't match the currently authenticated credentials.

Händelsedetaljer

channelConnect

Händelse

Typ av händelseobjekt: mx.messaging.events.ChannelEvent
egenskap ChannelEvent.type = mx.messaging.events.ChannelEvent.CONNECT

Dispatched after the channel has connected to its endpoint.

Channel and its subclasses issue a Channel.Connect.Failed code whenever there is an issue in a channel's connect attempts to a remote destination. An AMFChannel object issues Channel.Call.Failed code when the channel is already connected but it gets a Call.Failed code from its underlying NetConnection.

The CONNECT event type; indicates that the Channel connected to its endpoint.

The value of this constant is "channelConnect".

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`channel`	The channel that generated 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`.
`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.
`reconnecting`	Indicates whether the channel that generated this event is reconnecting.
`rejected`	Indicates whether the channel that generated this event was rejected. This would be true in the event that the channel has been disconnected due to inactivity and should not attempt to failover or connect on an alternate channel.

Konstantdetaljer

CONNECT_TIMEOUT_SECONDS

Konstant

protected static const CONNECT_TIMEOUT_SECONDS:String = "connect-timeout-seconds"

ENABLE_SMALL_MESSAGES

Konstant

protected static const ENABLE_SMALL_MESSAGES:String = "enable-small-messages"

FALSE

Konstant

protected static const FALSE:String = "false"

RECORD_MESSAGE_SIZES

Konstant

protected static const RECORD_MESSAGE_SIZES:String = "record-message-sizes"

RECORD_MESSAGE_TIMES

Konstant

protected static const RECORD_MESSAGE_TIMES:String = "record-message-times"

REQUEST_TIMEOUT_SECONDS

Konstant

protected static const REQUEST_TIMEOUT_SECONDS:String = "request-timeout-seconds"

SERIALIZATION

Konstant

protected static const SERIALIZATION:String = "serialization"

TRUE

Konstant

protected static const TRUE:String = "true"

Juridiska meddelanden | Onlinesekretesspolicy

Property	Value
`bubbles`	Determined by the constructor; defaults to false.
`cancelable`	Determined by the constructor; defaults to false.
`kind`	The kind of change; PropertyChangeEventKind.UPDATE or PropertyChangeEventKind.DELETE.
`oldValue`	The original property value.
`newValue`	The new property value, if any.
`property`	The property that changed.
`source`	The object that contains the property that changed.
`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`.
`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.

	`id:String` (default = `null`) — The id of this channel.

	`uri:String` (default = `null`) — The endpoint URI for this channel.

Channel - AS3 BlazeDS LCDS

Paketx

Språkelement

Bilagor

Paket mx.messaging

authenticated

channelSets

connected

connectTimeout

endpoint

failoverURIs

id

protocol

reconnecting

recordMessageSizes

recordMessageTimes

requestTimeout

shouldBeConnected

uri

applyClientLoadBalancingSettings

applySettings

connect

connectFailed

connectSuccess

connectTimeoutHandler

disconnect

disconnectFailed

disconnectSuccess

flexClientWaitHandler

getMessageResponder

internalConnect

internalDisconnect

internalSend

logout

send

setCredentials

channelConnect

channelDisconnect

channelFault

message

propertyChange

CONNECT_TIMEOUT_SECONDS

ENABLE_SMALL_MESSAGES

FALSE

RECORD_MESSAGE_SIZES

RECORD_MESSAGE_TIMES

REQUEST_TIMEOUT_SECONDS

SERIALIZATION

TRUE