Diffusion Apple API  6.6.2
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
Class Methods | List of all members
PTDiffusionRemoteServerConnectionOption Class Reference

Introduction

Connection option key for a remote server.

This is used by the Remote Servers feature

Since
6.5
Inheritance diagram for PTDiffusionRemoteServerConnectionOption:
PTDiffusionEnumeration

Class Methods

(instancetype) + reconnectionTimeout
 
(instancetype) + retryDelay
 
(instancetype) + recoveryBufferSize
 
(instancetype) + inputBufferSize
 
(instancetype) + outputBufferSize
 
(instancetype) + maximumQueueSize
 
(instancetype) + connectionTimeout
 
(instancetype) + writeTimeout
 
- Class Methods inherited from PTDiffusionEnumeration
(NSSet< PTDiffusionEnumeration * > *) + elements
 

Additional Inherited Members

- Instance Methods inherited from PTDiffusionEnumeration
(BOOL) - isEqualToEnumeration:
 

Method Documentation

+ (instancetype) connectionTimeout

Specifies the connection timeout session attribute value (in milliseconds).

If a value is not specified PTDiffusionSessionConfiguration.connectionTimeout is used.

Returns
Instance representing the key for the connection timeout session attribute.
Since
6.5
+ (instancetype) inputBufferSize

Specifies the input buffer size session attribute.

This is the size of the input buffer to use for the connection with the remote server. It is used to receive messages from the remote server. This should be set to the same size as the output buffer used at the remote server.

If not specified, a default of 1024k is used.

Returns
Instance representing the key for the input buffer size session attribute.
Since
6.5
+ (instancetype) maximumQueueSize

Specifies the maximum queue size session attribute.

This is the maximum number of messages that can be queued to send to the remote server. If this number is exceeded, the connection will be closed. This must be sufficient to cater for messages that may be queued whilst disconnected (awaiting reconnect).

The default value is 10,000 messages.

Returns
Instance representing the key for the maximum queue size session attribute.
Since
6.5
+ (instancetype) outputBufferSize

Specifies the output buffer size session attribute.

This is the size of the output buffer to use for the connection with the remote server. It is used to send messages to the remote server. This should be set to the same size as the input buffer used by the remote server.

If not specified, a default of 1024k is used.

Returns
Instance representing the key for output buffer size session attribute.
Since
6.5
+ (instancetype) reconnectionTimeout

Specifies the reconnection timeout session attribute.

This is the total time in milliseconds that will be allowed to reconnect a failed connection to the remote server.

For reconnection to work the remote server connector must have been configured to support reconnection.

If a value is not specified PTDiffusionSessionConfiguration.reconnectionTimeout is used.

Returns
Instance representing the key for the reconnection timeout session attribute.
Since
6.5
+ (instancetype) recoveryBufferSize

Specifies the recovery buffer size session attribute.

If the remote server is configured to support reconnection, a session established with a non-zero reconnect-timeout retains a buffer of sent messages. If the session disconnects and reconnects, this buffer is used to re-send messages that the server has not received.

The default value is 10,000 messages. If reconnect-timeout is 0 then this value is ignored.

Returns
Instance representing the key for the recovery buffer size session attribute.
Since
6.5
+ (instancetype) retryDelay

Specifies the delay after losing a connection before attempting a reconnection.

The value is specified in milliseconds. Default 1000 (1 second).

Returns
Instance representing the key for the delay after losing a connection before attempting a reconnection.
Since
6.5
+ (instancetype) writeTimeout

Specifies the write timeout session attribute value (in milliseconds).

Returns
Instance representing the key for the write timeout session attribute.
Since
6.5