couchbase-lite-ee/kotbase/URLEndpointListenerConfiguration

URLEndpointListenerConfiguration

expect class URLEndpointListenerConfiguration(source)

ENTERPRISE EDITION API

Configuration information for a URL endpoint listener. There are two varieties: Http and Tls.

actual class URLEndpointListenerConfiguration : DelegatedClass<<Error class: unknown class>> (source)
actual class URLEndpointListenerConfiguration(source)

Constructors

Link copied to clipboard
expect constructor(database: Database, networkInterface: String? = null, port: Int = 0, disableTls: Boolean = false, identity: TLSIdentity? = null, authenticator: ListenerAuthenticator? = null, readOnly: Boolean = false, enableDeltaSync: Boolean = false)

Create a listener configuration, for the specified database, with default values.

expect constructor(config: URLEndpointListenerConfiguration)

Clone the passed listener configuration.

actual constructor(database: Database, networkInterface: String?, port: Int, disableTls: Boolean, identity: TLSIdentity?, authenticator: ListenerAuthenticator?, readOnly: Boolean, enableDeltaSync: Boolean)
actual constructor(config: URLEndpointListenerConfiguration)
actual constructor(database: Database, networkInterface: String?, port: Int, disableTls: Boolean, identity: TLSIdentity?, authenticator: ListenerAuthenticator?, readOnly: Boolean, enableDeltaSync: Boolean)
actual constructor(config: URLEndpointListenerConfiguration)

Types

Link copied to clipboard
expect object Companion
actual object Companion
actual object Companion

Properties

Link copied to clipboard
expect var authenticator: ListenerAuthenticator?

When TLS is enabled, a null authenticator (the default) will allow clients whose certificate chains can be verified by one of the OS-bundled root certificates. There are two types of TLS authenticators. See ListenerCertificateAuthenticator

actual var authenticator: ListenerAuthenticator?
actual var authenticator: ListenerAuthenticator?
Link copied to clipboard
expect val database: Database

The configured database.

actual val database: Database
actual val database: Database
Link copied to clipboard
expect var isDeltaSyncEnabled: Boolean

Is delta sync enabled.

actual var isDeltaSyncEnabled: Boolean
actual var isDeltaSyncEnabled: Boolean
Link copied to clipboard
expect var isReadOnly: Boolean

Is connection read-only.

actual var isReadOnly: Boolean
actual var isReadOnly: Boolean
Link copied to clipboard
expect var isTlsDisabled: Boolean

If this configuration will disable TLS in its associated listener.

actual var isTlsDisabled: Boolean
actual var isTlsDisabled: Boolean
Link copied to clipboard
expect var networkInterface: String?

The name of the configured network interface on which to configure the listener (e.g. "en0")

actual var networkInterface: String?
actual var networkInterface: String?
Link copied to clipboard
expect var port: Int?

The port number on which to configure the listener (between 0 and 65535, inclusive).

actual var port: Int?
actual var port: Int?
Link copied to clipboard
expect var tlsIdentity: TLSIdentity?

The TLS identity with the certificates and keys for the associated listener.

actual var tlsIdentity: TLSIdentity?
actual var tlsIdentity: TLSIdentity?

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun URLEndpointListenerConfiguration?.newConfig(database: Database? = null, networkInterface: String? = null, port: Int? = null, disableTls: Boolean? = null, identity: TLSIdentity? = null, authenticator: ListenerAuthenticator? = null, readOnly: Boolean? = null, enableDeltaSync: Boolean? = null): URLEndpointListenerConfiguration

ENTERPRISE EDITION API

Link copied to clipboard
open override fun toString(): String