URLEndpointListenerConfiguration

expect constructor(collections: Set<Collection>, networkInterface: String? = null, port: Int = Defaults.Listener.PORT, disableTls: Boolean = Defaults.Listener.DISABLE_TLS, identity: TLSIdentity? = null, authenticator: ListenerAuthenticator? = null, readOnly: Boolean = Defaults.Listener.READ_ONLY, enableDeltaSync: Boolean = Defaults.Listener.ENABLE_DELTA_SYNC)(source)

Create a URLEndpointListenerConfiguration with the passed properties. The set of passed Collections must contain at least one collection and all of the collections it contains must belong to the same scope and the same database, otherwise an InvalidArgumentException will be thrown. If one of the specified collections is deleted during replication, connected clients will be closed with an error.

Parameters

collections

the collections to which the listener is attached

networkInterface

the name of the interface on which to receive connections

port

the ip port (0 - 65535) on which to configure the listener. Default is 0: first available

disableTls

set true to turn of TLS. Default is false

identity

the identity this listener will use to authenticate itself

authenticator

the predicate used to authenticate clients

readOnly

set true to prevent modification of the local connections

enableDeltaSync

set true to turn on fast synching.

expect constructor(config: URLEndpointListenerConfiguration)(source)

Clone the passed listener configuration.

Parameters

config

the configuration to duplicate

expect constructor(database: Database, networkInterface: String? = null, port: Int = Defaults.Listener.PORT, disableTls: Boolean = Defaults.Listener.DISABLE_TLS, identity: TLSIdentity? = null, authenticator: ListenerAuthenticator? = null, readOnly: Boolean = Defaults.Listener.READ_ONLY, enableDeltaSync: Boolean = Defaults.Listener.ENABLE_DELTA_SYNC)(source)

Deprecated

Use URLEndpointListenerConfiguration(Collections)

Replace with

URLEndpointListenerConfiguration(setOf(database.defaultCollection), networkInterface, port, disableTls, identity, authenticator, readOnly, enableDeltaSync)

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

Parameters

database

the database to which the listener is attached

actual constructor(collections: Set<Collection>, networkInterface: String?, port: Int, disableTls: Boolean, identity: TLSIdentity?, authenticator: ListenerAuthenticator?, readOnly: Boolean, enableDeltaSync: Boolean)(source)

actual constructor(config: URLEndpointListenerConfiguration)(source)

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

Deprecated

Use URLEndpointListenerConfiguration(Collections)

Replace with

URLEndpointListenerConfiguration(setOf(database.defaultCollection), networkInterface, port, disableTls, identity, authenticator, readOnly, enableDeltaSync)

actual constructor(collections: Set<Collection>, networkInterface: String?, port: Int, disableTls: Boolean, identity: TLSIdentity?, authenticator: ListenerAuthenticator?, readOnly: Boolean, enableDeltaSync: Boolean)(source)

actual constructor(config: URLEndpointListenerConfiguration)(source)

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

Deprecated

Use URLEndpointListenerConfiguration(Collections)

Replace with

URLEndpointListenerConfiguration(setOf(database.defaultCollection), networkInterface, port, disableTls, identity, authenticator, readOnly, enableDeltaSync)