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

Introduction

The reason for failure to add a Topic.

See Also
PTDiffusionTopicControlFeature
Deprecated:
Since 6.0.6. Will be removed in a future release.
Since
5.7
Inheritance diagram for PTDiffusionTopicAddFailReason:
PTDiffusionEnumeration

Class Methods

(instancetype) + exists
 
(instancetype) + existsMismatch
 
(instancetype) + invalidName
 
(instancetype) + invalidDetails
 
(instancetype) + userCodeError
 
(instancetype) + topicNotFound
 
(instancetype) + permissionsFailure
 
(instancetype) + initialiseError
 
(instancetype) + unexpectedError
 
(instancetype) + clusterRepartition
 
(instancetype) + exceededLicenceLimit
 
(instancetype) + incompatibleParent
 
(instancetype) + incompatibleMaster
 
(instancetype) + existsIncompatible
 
- Class Methods inherited from PTDiffusionEnumeration
(instancetype) + NS_UNAVAILABLE
 
(NSSet< PTDiffusionEnumeration * > *) + elements
 

Additional Inherited Members

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

Method Documentation

+ (instancetype) clusterRepartition

When trying to create the topic the cluster was migrating the partition that owns the topic. The correct owner could not be identified and the request failed. This is a transient failure for the duration of the partition migration.

Since
6.0
+ (instancetype) exceededLicenceLimit

Adding the topic failed because of a license limit.

Since
6.1
+ (instancetype) exists

Topic already existed with exactly the same specification.

Since
5.7
+ (instancetype) existsIncompatible

Adding the topic failed because a topic is already bound to the specified path but the caller does not have the rights to manage it.

This can be because the topic is being managed by a component with exclusive control over the topic, such as fan-out or a publisher and thus the caller will not be able to update or remove the topic.

If the caller has suitable permissions then it could still subscribe to the topic, but the topic's specification may be different from that requested.

Since
6.1
+ (instancetype) existsMismatch

Topic already exists at the same path but with a different specification.

Since
5.7
+ (instancetype) incompatibleMaster

Adding a slave topic failed because a topic owned by a publisher is already bound to the specified master path.

Since
6.1
+ (instancetype) incompatibleParent

Adding the topic failed because a topic owned by a publisher is already bound to the parent path.

Since
6.1
+ (instancetype) initialiseError

Initialisation of topic with supplied content failed, possibly because it was of the wrong format.

Since
5.7
+ (instancetype) invalidDetails

Some aspect of the topic specification failed validation.

This can include an attempt to add a PTDiffusionTopicType_SingleValue or PTDiffusionTopicType_Record topic at a path that is configured for replication.

Since
5.7
+ (instancetype) invalidName

The name of the topic was found to be invalid.

Since
5.7
+ (instancetype) permissionsFailure

The client was denied permission to add a topic of the specified type at the given point in the topic hierarchy.

Since
5.7
+ (instancetype) topicNotFound

A referenced Topic was not found or was not of the correct type.

Deprecated:
Since 6.1. This value is no longer used and will be removed in a future release.
Since
5.7
+ (instancetype) unexpectedError

An unexpected error occurred whilst attempting to create the Topic. See the server log for more details.

Since
5.7
+ (instancetype) userCodeError

A user supplied class could either not be found or could not be instantiated at the server.

Since
5.7