Packageorg.granite.gravity
Classpublic class Consumer
InheritanceConsumer Inheritance TopicMessageAgent Inheritance mx.messaging.MessageAgent

Gravity-specific implementation of the Consumer message agent



Public Properties
 PropertyDefined by
  selector : String
Consumer
  subscribed : Boolean
[read-only]
Consumer
  timestamp : Number
Consumer
 Inheritedtopic : String
TopicMessageAgent
Public Methods
 MethodDefined by
  
Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")
Consumer
  
acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void
Consumer
  
channelConnectHandler(event:ChannelEvent):void
Consumer
  
channelDisconnectHandler(event:ChannelEvent):void
Consumer
  
fault(errMsg:ErrorMessage, msg:IMessage):void
Consumer
 Inherited
logout():void
TopicMessageAgent
  
receive(timestamp:Number = 0):void
Consumer
  
reply(msg:IMessage, reply:AsyncMessage):*
Consumer
  
resubscribe(clientId:String = null):void
Consumer
 Inherited
setIdentity(username:String, password:String, charset:String = null):void
TopicMessageAgent
  
subscribe(clientId:String = null):void
Consumer
  
unsubscribe():void
Consumer
Protected Methods
 MethodDefined by
 Inherited
TopicMessageAgent
Events
 EventSummaryDefined by
    Consumer
Property detail
selectorproperty
selector:String  [read-write]Implementation
    public function get selector():String
    public function set selector(value:String):void
subscribedproperty 
subscribed:Boolean  [read-only]Implementation
    public function get subscribed():Boolean
timestampproperty 
timestamp:Number  [read-write]Implementation
    public function get timestamp():Number
    public function set timestamp(value:Number):void
Constructor detail
Consumer()constructor
public function Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")Parameters
messageType:String (default = "flex.messaging.messages.AsyncMessage")
Method detail
acknowledge()method
public override function acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):voidParameters
ackMsg:AcknowledgeMessage
 
msg:IMessage
channelConnectHandler()method 
public override function channelConnectHandler(event:ChannelEvent):voidParameters
event:ChannelEvent
channelDisconnectHandler()method 
public override function channelDisconnectHandler(event:ChannelEvent):voidParameters
event:ChannelEvent
fault()method 
public override function fault(errMsg:ErrorMessage, msg:IMessage):voidParameters
errMsg:ErrorMessage
 
msg:IMessage
receive()method 
public function receive(timestamp:Number = 0):voidParameters
timestamp:Number (default = 0)
reply()method 
public function reply(msg:IMessage, reply:AsyncMessage):*Parameters
msg:IMessage
 
reply:AsyncMessage

Returns
*
resubscribe()method 
public function resubscribe(clientId:String = null):voidParameters
clientId:String (default = null)
subscribe()method 
public function subscribe(clientId:String = null):voidParameters
clientId:String (default = null)
unsubscribe()method 
public function unsubscribe():void
Event detail
messageevent 
Event object type: mx.messaging.events.MessageEvent