Packageorg.granite.gravity.channels
Classpublic class GravityChannel
InheritanceGravityChannel Inheritance mx.messaging.Channel
SubclassesSecureGravityChannel

Channel implementation for the Gravity Comet based communication with serlvet containers


Public Properties
 PropertyDefined by
  clientId : String
[read-only]
GravityChannel
  commandUri : String
[read-only]
GravityChannel
  encodeMessageBody : Boolean
GravityChannel
  protocol : String
[read-only]
GravityChannel
  reconnectIntervalMs : Number
GravityChannel
  reconnectMaxAttempts : Number
GravityChannel
  tunnelUri : String
[read-only]
GravityChannel
Protected Properties
 PropertyDefined by
  tunnel : GravityStreamTunnel
[read-only]
GravityChannel
Public Methods
 MethodDefined by
  
GravityChannel(id:String, uri:String)
GravityChannel
  
callResponder(responder:MessageResponder, response:IMessage):void
GravityChannel
  
streamConnectFailed(stream:GravityStream, code:String, e:Error = null):void
GravityChannel
  
streamConnectSuccess(stream:GravityStream, clientId:String):void
GravityChannel
  
streamDisconnectFailed(stream:GravityStream, code:String, e:Error = null):void
GravityChannel
  
streamDisconnectSuccess(stream:GravityStream, rejected:Boolean = false):void
GravityChannel
Protected Methods
 MethodDefined by
  
getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder
GravityChannel
  
internalCallResponder(responder:MessageResponder, response:IMessage):void
GravityChannel
  
internalConnect():void
GravityChannel
  
internalDisconnect(rejected:Boolean = false):void
GravityChannel
  
internalSend(messageResponder:MessageResponder):void
GravityChannel
  
newTunnel():GravityStreamTunnel
GravityChannel
Property detail
clientIdproperty
clientId:String  [read-only]Implementation
    public function get clientId():String
commandUriproperty 
commandUri:String  [read-only]Implementation
    public function get commandUri():String
encodeMessageBodyproperty 
encodeMessageBody:Boolean  [read-write]Implementation
    public function get encodeMessageBody():Boolean
    public function set encodeMessageBody(value:Boolean):void
protocolproperty 
protocol:String  [read-only]Implementation
    public function get protocol():String
reconnectIntervalMsproperty 
reconnectIntervalMs:Number  [read-write]Implementation
    public function get reconnectIntervalMs():Number
    public function set reconnectIntervalMs(value:Number):void
reconnectMaxAttemptsproperty 
reconnectMaxAttempts:Number  [read-write]Implementation
    public function get reconnectMaxAttempts():Number
    public function set reconnectMaxAttempts(value:Number):void
tunnelproperty 
tunnel:GravityStreamTunnel  [read-only]Implementation
    protected function get tunnel():GravityStreamTunnel
tunnelUriproperty 
tunnelUri:String  [read-only]Implementation
    public function get tunnelUri():String
Constructor detail
GravityChannel()constructor
public function GravityChannel(id:String, uri:String)Parameters
id:String
 
uri:String
Method detail
callResponder()method
public function callResponder(responder:MessageResponder, response:IMessage):voidParameters
responder:MessageResponder
 
response:IMessage
getMessageResponder()method 
protected override function getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponderParameters
agent:MessageAgent
 
message:IMessage

Returns
MessageResponder
internalCallResponder()method 
protected function internalCallResponder(responder:MessageResponder, response:IMessage):voidParameters
responder:MessageResponder
 
response:IMessage
internalConnect()method 
protected override function internalConnect():void
internalDisconnect()method 
protected override function internalDisconnect(rejected:Boolean = false):voidParameters
rejected:Boolean (default = false)
internalSend()method 
protected override function internalSend(messageResponder:MessageResponder):voidParameters
messageResponder:MessageResponder
newTunnel()method 
protected function newTunnel():GravityStreamTunnel

Returns
GravityStreamTunnel
streamConnectFailed()method 
public function streamConnectFailed(stream:GravityStream, code:String, e:Error = null):voidParameters
stream:GravityStream
 
code:String
 
e:Error (default = null)
streamConnectSuccess()method 
public function streamConnectSuccess(stream:GravityStream, clientId:String):voidParameters
stream:GravityStream
 
clientId:String
streamDisconnectFailed()method 
public function streamDisconnectFailed(stream:GravityStream, code:String, e:Error = null):voidParameters
stream:GravityStream
 
code:String
 
e:Error (default = null)
streamDisconnectSuccess()method 
public function streamDisconnectSuccess(stream:GravityStream, rejected:Boolean = false):voidParameters
stream:GravityStream
 
rejected:Boolean (default = false)