DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
DFConnectionDetails Class Reference

A collection of DFServerDetails objects, with some default values. More...

#import <DFConnectionDetails.h>

Inheritance diagram for DFConnectionDetails:
Collaboration diagram for DFConnectionDetails:

Instance Methods

(id) - initWithServer:topics:andCredentials:
 Initialiase the DFConnectionDetails object.
 
(id) - initWithServers:topics:andCredentials:
 Initialiase the DFConnectionDetails object.
 
(void) - reset
 Reset the next-server-index to zero.
 
(DFServerDetails *) - getNextServerDetails
 Get next serverDetails object from the list.
 

Properties

DFBaseConnectionPropertiesdefaults
 The set of defaults to use when a DFServerDetails object in serverDetails lacks a setting.
 
NSArray * serverDetails
 The pool of DFServerDetails objects.
 
BOOL isAutoAck
 YES if auto acknowledge is switched on.
 
BOOL isAutoFailover
 Once a connection to Diffusion is place, should it fail, if there is a pool of DFServerDetail objects to pick from, then the next DFServerDetail object is chosen and a connection placed to it.
 
BOOL isLoadBalance
 If YES, the list of of DFServerDetail objects is shuffled prior to use.
 
BOOL isCascade
 When the Diffusion client attempts to place a connection, should the attempt fail, then the next server-details object in the list is chosen.
 
DFServerDetailscurrentServerDetails
 Server details object currently in use.
 

Detailed Description

A collection of DFServerDetails objects, with some default values.

Method Documentation

- (id) initWithServer: (DFServerDetails *)  server
topics: (NSString *)  topicSet
andCredentials: (DFCredentials *)  credentials 

Initialiase the DFConnectionDetails object.

Parameters
serverA single DFServerDetails object, detailing the location of the Diffusion server
topicSetA default list of topic-names, as a comma seperated list, may be nil.
credentialsA default set of credentials to use, may be nil.
- (id) initWithServers: (NSArray *)  servers
topics: (NSString *)  topicSet
andCredentials: (DFCredentials *)  credentials 

Initialiase the DFConnectionDetails object.

Parameters
serversAn NSArray of DFServerDetails object, detailing the location of the Diffusion server
topicSetA default list of topic-names, as a comma seperated list, may be nil.
credentialsA default set of credentials to use, may be nil.

Property Documentation

- (BOOL) isAutoAck
readwritenonatomicassign

YES if auto acknowledge is switched on.

If this is set to NO, it is down to the implementation to ack message from the server

- (BOOL) isCascade
readwritenonatomicassign

When the Diffusion client attempts to place a connection, should the attempt fail, then the next server-details object in the list is chosen.

It is similar to isAutoFailover except this logic is apply prior to a connection


The documentation for this class was generated from the following file: