Represents the current connection state of the remote server. More...

#include <PTDiffusionRemoteServerConnectionState.h>

Inheritance diagram for PTDiffusionRemoteServerConnectionState:

Class Methods
(instancetype)	+ inactive
(instancetype)	+ connected
(instancetype)	+ retrying
(instancetype)	+ failed
(instancetype)	+ missing
Class Methods inherited from PTDiffusionEnumeration
(NSSet< PTDiffusionEnumeration * > *)	+ elements

Additional Inherited Members
Instance Methods inherited from PTDiffusionEnumeration
(BOOL)	- isEqualToEnumeration:

Detailed Description

Represents the current connection state of the remote server.

This is used by the Remote Servers feature

Since: 6.5

Method Documentation

◆ connected

+ (instancetype) connected

The remote server is connected and actively in use by components that require it.

Returns: Instance representing the connected connection state.

Since: 6.5

◆ failed

+ (instancetype) failed

The connection failed to establish.

If the connection was in an inactive or failed state state, a test connection was tried and failed.

In this case [PTDiffusionCheckRemoteServerResult failureMessage] will provide more detail.

Returns: Instance representing the failed connection state.

Since: 6.5

◆ inactive

+ (instancetype) inactive

The connection is inactive.

This means that the remote server can successfully connect but a physical connection is not being maintained as there are no components that require the remote server.

If in an inactive or failed state, a test connection will have been tried to check that the connection can be made and the connection will then have been closed.

Returns: Instance representing the inactive connection state.

Since: 6.5

◆ missing

+ (instancetype) missing

The named remote server did not exist.

Returns: Instance representing the remote server missing connection state.

Since: 6.5

◆ retrying

+ (instancetype) retrying

The connection has failed but a retry is scheduled.

In this case [PTDiffusionCheckRemoteServerResult failureMessage] will provide details of the failure that resulted in a retry.

Returns: Instance representing the retrying connection state.

Since: 6.5

Class Methods