Package | com.pushtechnology.diffusion.events |
Class | public class DiffusionConnectionEvent |
Inheritance | DiffusionConnectionEvent ![]() |
Method | Defined By | ||
---|---|---|---|
DiffusionConnectionEvent(serverDetails:ServerDetails, connected:Boolean, clientID:String = null) | DiffusionConnectionEvent | ||
clone():Event [override] | DiffusionConnectionEvent | ||
getClientID():String | DiffusionConnectionEvent | ||
getErrorMessage():String | DiffusionConnectionEvent | ||
DiffusionConnectionEvent | |||
hasExhaustedServerDetails():Boolean | DiffusionConnectionEvent | ||
hasLostConnection():Boolean | DiffusionConnectionEvent | ||
isConnected():Boolean | DiffusionConnectionEvent | ||
isReconnected():Boolean | DiffusionConnectionEvent | ||
setConnectionAborted():void | DiffusionConnectionEvent | ||
setConnectionLost():void | DiffusionConnectionEvent | ||
setConnectionRejected():void | DiffusionConnectionEvent | ||
setErrorMessage(message:String):void | DiffusionConnectionEvent | ||
setExhaustedServerDetails():void | DiffusionConnectionEvent | ||
setReconnected():void | DiffusionConnectionEvent | ||
toString():String [override] | DiffusionConnectionEvent | ||
wasClientAborted():Boolean | DiffusionConnectionEvent | ||
wasConnectionRejected():Boolean | DiffusionConnectionEvent |
Constant | Defined By | ||
---|---|---|---|
CONNECTION : String = DiffusionConnection [static] | DiffusionConnectionEvent |
DiffusionConnectionEvent | () | Constructor |
public function DiffusionConnectionEvent(serverDetails:ServerDetails, connected:Boolean, clientID:String = null)
serverDetails:ServerDetails | |
connected:Boolean | |
clientID:String (default = null )
|
clone | () | method |
override public function clone():Event
ReturnsEvent |
getClientID | () | method |
public function getClientID():String
Returns
String — clientID, this will only be set if the connection has been sucessful
|
getErrorMessage | () | method |
public function getErrorMessage():String
Returns
String — the error message. null if no error reported.
|
getServerDetails | () | method |
hasExhaustedServerDetails | () | method |
public function hasExhaustedServerDetails():Boolean
Returns
Boolean — true if the list of server details has been exhausted
|
hasLostConnection | () | method |
public function hasLostConnection():Boolean
Returns
Boolean — true is the connection was lost
|
isConnected | () | method |
public function isConnected():Boolean
Returns
Boolean — returns true if the client has connected to Diffusion
|
isReconnected | () | method |
public function isReconnected():Boolean
Returns
Boolean — true if the connection was reconnected
|
setConnectionAborted | () | method |
public function setConnectionAborted():void
setConnectionLost | () | method |
public function setConnectionLost():void
setConnectionRejected | () | method |
public function setConnectionRejected():void
setErrorMessage | () | method |
public function setErrorMessage(message:String):void
Parameters
message:String |
setExhaustedServerDetails | () | method |
public function setExhaustedServerDetails():void
setReconnected | () | method |
public function setReconnected():void
toString | () | method |
override public function toString():String
ReturnsString |
wasClientAborted | () | method |
public function wasClientAborted():Boolean
Returns
Boolean — true if Diffusion closed the client, or the client has been blocked
|
wasConnectionRejected | () | method |
public function wasConnectionRejected():Boolean
Returns
Boolean — true if the connection was rejected by the Diffusion Server. This may be due to
invalid credentials
|
CONNECTION | Constant |
public static const CONNECTION:String = DiffusionConnection