Diffusion Apple API  6.5.1
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
PTDiffusionCloseReason Class Reference

Introduction

Specifies the reason why a session has been closed.

This is used by the Client Control feature

Since
6.5
Inheritance diagram for PTDiffusionCloseReason:
PTDiffusionEnumeration

Class Methods

(instancetype) + connectionLost
 
(instancetype) + ioException
 
(instancetype) + clientUnresponsive
 
(instancetype) + messageQueueLimitReached
 
(instancetype) + closedByClient
 
(instancetype) + messageTooLarge
 
(instancetype) + internalError
 
(instancetype) + invalidInboundMessage
 
(instancetype) + aborted
 
(instancetype) + lostMessages
 
(instancetype) + serverClosing
 
(instancetype) + closedByController
 
(instancetype) + failedOver
 
- Class Methods inherited from PTDiffusionEnumeration
(NSSet< PTDiffusionEnumeration * > *) + elements
 

Additional Inherited Members

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

Method Documentation

+ (instancetype) aborted

The client connection was aborted by the server, possibly because the connection was disallowed.

This is may be because the connection was disallowed. Abort messages are also sent to clients that have unrecognised client IDs. This may be because the server closed the client previously but the client is unaware of this and tried to continue interacting with the server.

Returns
Instance indicating the client connection was aborted by the server.
Since
6.5
+ (instancetype) clientUnresponsive

The client had become unresponsive.

The client has either failed to respond to a ping message in a timely manner or the client has failed to open an HTTP poll for messages. The client does not appear to be receiving messages.

Returns
Instance indicating the client has become unresponsive.
Since
6.5
+ (instancetype) closedByClient

The client requested close. Not recoverable.

Returns
Instance indicating the client requested close.
Since
6.5
+ (instancetype) closedByController

Closed by a client session.

A control session initiated the client close.

Returns
Instance indicating the sessiion was closed by another client session.
Since
6.5
+ (instancetype) connectionLost

The connection to the client was lost - possibly dropped by the client. Recoverable.

A client may be closed for many reasons that are presented as CONNECTION_LOST.

During a connection attempt, the connection can be lost. The server might have received a connection or reconnection request from a client already connected. The server might have received a reconnection request without a session Id. The connection may not have been authorised because the credentials are wrong. The maximum number of clients might already be connected.

Once connected, the connection can be lost for different reasons. If the client closes its connection while the server is writing a message to the client. With the chunked encoding based connection the HTTP response is completed by the server. If the client does not open a new request within a timeout, the client will be closed. If a poll request times out and the server finds that the connection has already been closed by the client.

Returns
Instance indicating the connection to the client was lost.
Since
6.5
+ (instancetype) failedOver

The session has failed over to a different Diffusion server.

The session is still open but is now connected to a different Diffusion server. This server has evicted its view of the session from its set of local sessions.

Returns
Instance indicating the session has failed over to a different Diffusion server.
Since
6.5
+ (instancetype) internalError

An internal error occurred.

Returns
Instance indicating an internal error has occurred.
Since
6.5
+ (instancetype) invalidInboundMessage

An inbound message with an invalid format was received.

A message received by the server is not a valid Diffusion message. The server is unable to process this and closes the client that sent it.

Returns
Instance indicating an inbound message with an invalid format was received.
Since
6.5
+ (instancetype) ioException

An unexpected IO Exception occurred. Recoverable.

While trying to perform an I/O operation an exception was generated. This often means that a read was attempted from a closed TCP connection.

This can also happen to HTTP Comet streaming clients if there is a malformed chunk length header before a chunk of messages.

When handling SSL connections if there is a problem encrypting or decrypting a message the client will be closed for this reason.

Returns
Instance indicating an unexpected IO Exception occurred.
Since
6.5
+ (instancetype) lostMessages

Loss of messages from the client has been detected.

For example, whilst waiting for the arrival of missing messages in a sequence of messages a timeout has occurred.

HTTP based transports use multiple TCP connections. This can cause the messages to be received out of order. To reorder the messages those sent to the server may contain a sequence number indicating the correct order.

If a message is received out of order there is a short time for the earlier messages to be received. If the messages are not received in this time the client is closed.

Missing, invalid or duplicate sequence numbers will also close the client for this reason.

This cannot be recovered from as the client and the server are in inconsistent states.

Returns
Instance indicating loss of messages from the client has been detected.
Since
6.5
+ (instancetype) messageQueueLimitReached

The maximum outbound queue size was reached for the client. Not recoverable.

Messages sent to the client are placed in a queue. This queue has a maximum allowed size. If the queue limit is reached the client is closed and the queue discarded. The queue is intended to protect against slow consumers, reaching the queue limit is taken to mean that the client cannot keep up with the number of messages sent to it.

Returns
Instance indicating the maximum outbound queue size was reached for the client.
Since
6.5
+ (instancetype) messageTooLarge

The client sent a message that exceeded the maximum message size that can be processed by the server.

The server has a maximum message size that it can process on any single connector. If a client sends a message larger than this the server is unable to process it. When this happens the message is discarded and the client is closed.

Returns
Instance indicating the client send a message that exceeded the server maximum message size.
Since
6.5
+ (instancetype) serverClosing

The server is closing down.

The client was closed as part of the server shutdown process.

Returns
Instance indicating the server is closing down.
Since
6.5