Diffusion Apple API  6.6.0-preview.1
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
Enumerations | Functions | Variables
PTDiffusionTopicUnsubscriptionReason.h File Reference

Enumerations

enum  PTDiffusionTopicUnsubscriptionReason {
  PTDiffusionTopicUnsubscriptionReason_Requested = 0, PTDiffusionTopicUnsubscriptionReason_Control = 1, PTDiffusionTopicUnsubscriptionReason_Removal = 2, PTDiffusionTopicUnsubscriptionReason_Authorization = 3,
  PTDiffusionTopicUnsubscriptionReason_Unknown = 4, PTDiffusionTopicUnsubscriptionReason_SubscriptionRefresh = 0xfffffff0, PTDiffusionTopicUnsubscriptionReason_StreamChange = 0xfffffff1
}
 

Functions

NSString * PTDiffusionTopicUnsubscriptionReasonToString (PTDiffusionTopicUnsubscriptionReason reason)
 

Variables

import Foundation
 

Detailed Description

The reason that an unsubscription occurred.

Since
5.6

Enumeration Type Documentation

Enumerator
PTDiffusionTopicUnsubscriptionReason_Requested 

Unsubscribed by the subscribing client.

Since
5.6
PTDiffusionTopicUnsubscriptionReason_Control 

The unsubscription was requested either by another client or by the server.

Since
5.6
PTDiffusionTopicUnsubscriptionReason_Removal 

The unsubscription occurred because the topic was removed.

Since
5.6
PTDiffusionTopicUnsubscriptionReason_Authorization 

The unsubscription occurred because the session is no longer authorized to access the topic.

Since
5.9
PTDiffusionTopicUnsubscriptionReason_Unknown 

A reason that is unsupported by the session.

Since
6.1
PTDiffusionTopicUnsubscriptionReason_SubscriptionRefresh 

The server has re-subscribed this session to the topic. Existing streams are unsubscribed because the topic type and other attributes may have changed.

This can happen if a set of servers is configured to use session replication, and a session connected to one server reconnects ("fails over") to a different server.

Since
5.9
PTDiffusionTopicUnsubscriptionReason_StreamChange 

A fallback stream has been unsubscribed due to the addition of a stream that selects the topic.

Since
5.9

Function Documentation

NSString* PTDiffusionTopicUnsubscriptionReasonToString ( PTDiffusionTopicUnsubscriptionReason  reason)

Returns a string representation of a topic unsubscription reason.

Since
5.6