PTDiffusionMutableSessionConfiguration Class Reference

Introduction

A mutable session configuration can be modified prior to being used to define behaviour and policies to use when connection to Diffusion.

Since

5.6

Inheritance diagram for PTDiffusionMutableSessionConfiguration:

Properties
NSString *	principal
PTDiffusionCredentials *	credentials
id < PTDiffusionSessionErrorHandler >	errorHandler
NSNumber *	reconnectionTimeout
id < PTDiffusionSessionReconnectionStrategy >	reconnectionStrategy
NSTimeInterval	connectionTimeout
NSDictionary *	sslOptions
Properties inherited from PTDiffusionSessionConfiguration
NSString *	principal
PTDiffusionCredentials *	credentials
id < PTDiffusionSessionErrorHandler >	errorHandler
NSNumber *	reconnectionTimeout
id < PTDiffusionSessionReconnectionStrategy >	reconnectionStrategy
NSTimeInterval	connectionTimeout
NSDictionary *	sslOptions

Additional Inherited Members
Class Methods inherited from PTDiffusionSessionConfiguration
(NSTimeInterval)	+ defaultConnectionTimeout
Instance Methods inherited from PTDiffusionSessionConfiguration
(instancetype)	- initWithPrincipal:credentials:
(BOOL)	- isEqualToSessionConfiguration:

Property Documentation

- (NSTimeInterval) connectionTimeout

readwritenonatomicassign

The connection timeout.

This constrains the time taken to establish an initial connection to the server. The server is responsible for limiting the overall time taken to complete a connection once it has received the request.

If not explicitly set, defaultConnectionTimeout will be assumed.

Note

If this exceeds one hour (3,600 seconds) a warning will be logged and the connection timeout will be constrained to one hour.

Since

5.7

- (PTDiffusionCredentials*) credentials

readwritenonatomiccopy

The security credentials to use when opening the session.

A value of nil dictates that no credentials will be used when authenticating the session.

Since

5.6

- (id<PTDiffusionSessionErrorHandler>) errorHandler

readwritenonatomicassign

The error handler to be used once the session has been opened and after the open completion handler has been called.

A value of nil dictates that the default error handler will be employed. This should not be used for production applications as it will pollute the system log.

Note

Any failures in initially opening the session will be reported only to the open completion handler. The error handler supplied here will only be told about errors experienced once the session has been initally opened.

See Also

PTDiffusionSessionDefaultErrorHandler

Deprecated:

Since 5.9. Will be removed in a future release. Replaced by the error property on PTDiffusionSessionState.

Since

5.6.6

- (NSString*) principal

readwritenonatomiccopy

The security principal to use when opening the session.

A value of nil dictates that no principal name will be associated with the session, indicating anonymous authentication.

Since

5.6

- (id<PTDiffusionSessionReconnectionStrategy>) reconnectionStrategy

readwritenonatomicassign

The reconnection strategy that will be used on connection failure.

A value of nil when a valid reconnectionTimeout has been set dictates that the default reconnection strategy will be employed.

Since

5.6

- (NSNumber*) reconnectionTimeout

readwritenonatomicassign

The reconnection timeout in seconds that will be used on connection failure.

The reconnection timeout boxed by this number is accessed as a double representing an NSTimeInterval.

A value of nil or a negative boxed value both dictate that reconnection will be disabled.

Since

5.6

- (NSDictionary*) sslOptions

readwritenonatomiccopy

Security settings to be applied to the underlying transport streams for SSL/TLS encrypted connections.

A value of nil or an empty dictionary indicates that default settings, as defined by the host operating system, will be applied.

Supported keys are documented by Apple under 'CFStream Property SSL Settings Constants' in their Core Foundation CFStream Reference.

For example, a rudimentary approach to allowing otherwise disallowed self-signed certificates could be to disable validation of the certificate chain entirely:

configuration.sslOptions =
    [NSDictionary dictionaryWithObject:kCFBooleanFalse
                                forKey:kCFStreamSSLValidatesCertificateChain];

Since

5.7.1