CBLURLEndpointListenerConfiguration


@interface CBLURLEndpointListenerConfiguration : NSObject

ENTERPRISE EDITION ONLY.

The configuration used for configuring and creating a URLEndpointListener.

  • The database object.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CBLDatabase *_Nonnull database;

  • The port that the listener will listen to. If default value is zero which means that the listener will automatically select an available port to listen to when the listener is started.

    Declaration

    Objective-C

    @property (nonatomic) unsigned short port;

  • The network interface in the form of the IP Address or network interface name such as en0 that the listener will listen to. The default value is nil which means that the listener will listen to all network interfaces.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSString *networkInterface;

  • Disable TLS communication. The default value is NO which means that the TLS will be enabled by default.

    Declaration

    Objective-C

    @property (nonatomic) BOOL disableTLS;

  • The TLS Identity used for configuring TLS Communication. The default value is nil which means that a generated anonymous self-signed identity will be used unless the disableTLS property is set to YES.

    Declaration

    Objective-C

    @property (nonatomic, nullable) CBLTLSIdentity *tlsIdentity;

  • The authenticator used by the listener to authenticate clients.

    Declaration

    Objective-C

    @property (nonatomic, nullable) id<CBLListenerAuthenticator> authenticator;

  • Allow delta sync when replicating with the listener. The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableDeltaSync;

  • Allow only pull replication to pull changes from the listener. The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL readOnly;

  • Initializes a listener with the database object.

    Declaration

    Objective-C

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

  • Initializes a listener with the configuration object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConfig:
    (nonnull CBLURLEndpointListenerConfiguration *)config;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype) init NS_UNAVAILABLE;