Package | com.pushtechnology.diffusion |
Class | public class ConnectionDetails |
Inheritance | ConnectionDetails ![]() |
Load Balancing: The client will pick a server detail from the connection details at random.
Auto Failover: If the client was connected, and the connection is lost, then the next server from the connection details is selected.
Cascading: Cascading is normally used between socket and HTTP type connections. This is different from auto failover as cascading will be used if the client was never connected.
These flags can be used in conjunction with each other
A ConnectionDetailsEvent listener can be added to a Diffusion Client to listener to the events.
Method | Defined By | ||
---|---|---|---|
ConnectionDetails(serverDetails:ServerDetails, topicSet:String = null) | ConnectionDetails | ||
addServerDetails(serverDetails:ServerDetails):void
Add Server Details
Append to the existing collection of server details
| ConnectionDetails | ||
getAutoFailover():Boolean
Get Auto Failover
| ConnectionDetails | ||
getCascade():Boolean
Get Cascade
| ConnectionDetails | ||
Get Credentials
| ConnectionDetails | ||
getLoadBalancing():Boolean
Get Load Balancing
| ConnectionDetails | ||
getServerDetailsArray():Array
Get Server Details
| ConnectionDetails | ||
getTimeout():int
Get Timeout
| ConnectionDetails | ||
getTopicSet():String
This returns the TopicSet to connect with
| ConnectionDetails | ||
setAutoFailover(value:Boolean):void
Set Auto Failover
| ConnectionDetails | ||
setCascade(value:Boolean):void
Set Cascade
| ConnectionDetails | ||
setCredentials(credentials:DiffusionClientCredentials):void
Set the credentials, is can be ooverridden by setting credentials on server details
| ConnectionDetails | ||
setLoadBalancing(value:Boolean):void
Set Load Balancing
| ConnectionDetails | ||
setServerDetailsArray(serverDetails:Array):void
Set Server Details
| ConnectionDetails | ||
setTimeout(timeout:int):void
Set the connection timeout
| ConnectionDetails | ||
setTopicSet(topicSet:String):void
Set the TopicSet to connect with
| ConnectionDetails |
ConnectionDetails | () | Constructor |
public function ConnectionDetails(serverDetails:ServerDetails, topicSet:String = null)
Parameters
serverDetails:ServerDetails — default sever detail or null
| |
topicSet:String (default = null )
|
addServerDetails | () | method |
public function addServerDetails(serverDetails:ServerDetails):void
Add Server Details Append to the existing collection of server details
Parameters
serverDetails:ServerDetails |
getAutoFailover | () | method |
public function getAutoFailover():Boolean
Get Auto Failover
ReturnsBoolean |
getCascade | () | method |
public function getCascade():Boolean
Get Cascade
ReturnsBoolean |
getCredentials | () | method |
public function getCredentials():DiffusionClientCredentials
Get Credentials
ReturnsDiffusionClientCredentials |
getLoadBalancing | () | method |
public function getLoadBalancing():Boolean
Get Load Balancing
ReturnsBoolean |
getServerDetailsArray | () | method |
public function getServerDetailsArray():Array
Get Server Details
ReturnsArray |
getTimeout | () | method |
public function getTimeout():int
Get Timeout
Returnsint |
getTopicSet | () | method |
public function getTopicSet():String
This returns the TopicSet to connect with
ReturnsString |
setAutoFailover | () | method |
public function setAutoFailover(value:Boolean):void
Set Auto Failover
Parameters
value:Boolean |
setCascade | () | method |
public function setCascade(value:Boolean):void
Set Cascade
Parameters
value:Boolean |
setCredentials | () | method |
public function setCredentials(credentials:DiffusionClientCredentials):void
Set the credentials, is can be ooverridden by setting credentials on server details
Parameters
credentials:DiffusionClientCredentials |
setLoadBalancing | () | method |
public function setLoadBalancing(value:Boolean):void
Set Load Balancing
Parameters
value:Boolean |
setServerDetailsArray | () | method |
public function setServerDetailsArray(serverDetails:Array):void
Set Server Details
Parameters
serverDetails:Array — of server details
|
setTimeout | () | method |
public function setTimeout(timeout:int):void
Set the connection timeout
Parameters
timeout:int |
setTopicSet | () | method |
public function setTopicSet(topicSet:String):void
Set the TopicSet to connect with
Parameters
topicSet:String |