CBLMessageEndpointListenerConfiguration

@interface CBLMessageEndpointListenerConfiguration : NSObject

ENTERPRISE EDITION ONLY.

The configuration for the CBLMessageEndpointListener.

  • Deprecated

    Use collections instead.

    The local database.

    Declaration

    Objective-C

    @property (nonatomic, readonly) __deprecated_msg("Use collections instead.") CBLDatabase *database;

  • The data transmission protocol type.

    Declaration

    Objective-C

    @property (nonatomic) int protocolType;

  • The collections that will be available for replication. When the initWithDatabase: protocolType: is used, the property will contain the default collection.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray *_Nonnull collections;

  • Deprecated

    Use [… initWithCollections: protocolType:] instead.

    Initializes a CBLMessageEndpointListenerConfiguration object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDatabase:(nonnull CBLDatabase *)database
                            protocolType:(id)protocolType;

    Parameters

    database

    The local database.
    protocolType

    The data transmission protocol type.

    Return Value

    The CBLMessageEndpointListenerConfiguration object.

  • Init with the collections that will be available for replication.

    The specified collections must contain at least one collection, otherwise an Invalid Argument Exception will be thrown.

    All of the collections must belong to the same database, otherwise an Invalid Argument Exception will be thrown.

    If one of the collections is removed during the replication, the listener would be stopped, and the connections to the connected clients would be closed with an error - Need to sync the behavior and error code with SG.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCollections:(nonnull NSArray *)collections
                               protocolType:(id)protocolType;

  • Unavailable

    Not available

    Declaration

    Objective-C

    - (nonnull instancetype)init;