Class URLEndpointListenerConfiguration

A class for configuring a new URLEndpointListener instance

Inheritance

System.Object

URLEndpointListenerConfiguration

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Couchbase.Lite.P2P

Assembly: Couchbase.Lite.dll

Syntax

public sealed class URLEndpointListenerConfiguration

Remarks

NOTE: This is an enterprise edition feature

Constructors

URLEndpointListenerConfiguration(Database)

[DEPRECATED] Constructs a configuration object

Declaration

[Obsolete("URLEndpointListenerConfiguration(Database) is deprecated, please use URLEndpointListenerConfiguration(List<Collection>).")]
public URLEndpointListenerConfiguration(Database database)

Parameters

Type	Name	Description
Database	database	The local database to operate on

URLEndpointListenerConfiguration(IReadOnlyList<Collection>)

Constructs a configuration object

Declaration

public URLEndpointListenerConfiguration(IReadOnlyList<Collection> collections)

Parameters

Type	Name	Description
System.Collections.Generic.IReadOnlyList<Collection>	collections	The local collections to operate on

Exceptions

Type	Condition
CouchbaseLiteException	Throw if the given collections is null or empty.
CouchbaseLiteException	Throw if the given collections don't contain the same database.
CouchbaseLiteException	Throw if any collection in the given collections is not valid.

Properties

Authenticator

The authenticator used by the listener to authenticate the requests.

Declaration

public IListenerAuthenticator Authenticator { get; set; }

Property Value

Type	Description
IListenerAuthenticator

Remarks

NOTE: This is an enterprise edition feature

Collections

The list of collections that the listener should server as the server side of replciation

Declaration

public IReadOnlyList<Collection> Collections { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<Collection>

Database

[DEPRECATED] Gets the database that this listener operates on locally

Declaration

[Obsolete("Database is deprecated, please use Collections instead.")]
public Database Database { get; }

Property Value

Type	Description
Database

Remarks

NOTE: This is an enterprise edition feature

DisableTLS

Disable TLS communication. The default value is false which means that the TLS will be enabled by default. Default value is DefaultListenerDisableTls

Declaration

public bool DisableTLS { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

NOTE: This is an enterprise edition feature

EnableDeltaSync

Allow delta sync when replicating with the listener. The default value is false. Default value is DefaultListenerEnableDeltaSync

Declaration

public bool EnableDeltaSync { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

NOTE: This is an enterprise edition feature

NetworkInterface

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

public string NetworkInterface { get; set; }

Property Value

Type	Description
System.String

Remarks

NOTE: This is an enterprise edition feature

Port

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

Declaration

public ushort Port { get; set; }

Property Value

Type	Description
System.UInt16

Remarks

NOTE: This is an enterprise edition feature

ReadOnly

Allow only pull replication to pull changes from the listener. The default value is false. Default value is DefaultListenerReadOnly

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

NOTE: This is an enterprise edition feature

TlsIdentity

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

Declaration

public TLSIdentity TlsIdentity { get; set; }

Property Value

Type	Description
TLSIdentity

Remarks

NOTE: This is an enterprise edition feature