ARTConnectionDetails

Objective-C

@interface ARTConnectionDetails : NSObject

Swift

class ARTConnectionDetails : NSObject, @unchecked Sendable

Contains any constraints a client should adhere to and provides additional metadata about a ARTConnection, such as if a request to -[ARTChannelProtocol publish:callback:] a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.

  • Contains the client ID assigned to the token. If clientId is nil or omitted, then the client is prohibited from assuming a clientId in any operations, however if clientId is a wildcard string *, then the client is permitted to assume any clientId. Any other string value for clientId implies that the clientId is both enforced and assumed for all operations from this client.

    Declaration

    Objective-C

    @property (readonly, getter=getClientId, nullable) NSString *clientId;

    Swift

    var clientId: String? { get }

  • The connection secret key string that is used to resume a connection and its state.

    Declaration

    Objective-C

    @property (readonly, getter=getConnectionKey, nullable) NSString *connectionKey;

    Swift

    var connectionKey: String? { get }

  • The maximum message size is an attribute of an Ably account and enforced by Ably servers. maxMessageSize indicates the maximum message size allowed by the Ably account this connection is using. Overrides the default value of +[ARTDefault maxMessageSize].

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger maxMessageSize;

    Swift

    var maxMessageSize: Int { get }

  • Overrides the default maxFrameSize.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger maxFrameSize;

    Swift

    var maxFrameSize: Int { get }

  • The maximum allowable number of requests per second from a client or Ably. In the case of a realtime connection, this restriction applies to the number of messages sent, whereas in the case of REST, it is the total number of REST requests per second.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger maxInboundRate;

    Swift

    var maxInboundRate: Int { get }

  • The duration that Ably will persist the connection state for when a Realtime client is abruptly disconnected.

    See

    +[ARTDefault connectionStateTtl]

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval connectionStateTtl;

    Swift

    var connectionStateTtl: TimeInterval { get }

  • A unique identifier for the front-end server that the client has connected to. This server ID is only used for the purposes of debugging.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *serverId;

    Swift

    var serverId: String? { get }

  • The maximum length of time in milliseconds that the server will allow no activity to occur in the server to client direction. After such a period of inactivity, the server will send a HEARTBEAT or transport-level ping to the client. If the value is 0, the server will allow arbitrarily-long levels of inactivity.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval maxIdleInterval;

    Swift

    var maxIdleInterval: TimeInterval { get }