Class URLEndpointListener

A listener to provide websocket based endpoint for peer-to-peer replication. Once the listener is started, peer replicators can connect to the listener by using URLEndpoint.

Inheritance

System.Object

URLEndpointListener

Implements

System.IDisposable

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 URLEndpointListener : IDisposable

Remarks

NOTE: This is an enterprise edition feature

Constructors

URLEndpointListener(URLEndpointListenerConfiguration)

Construct a URLEndpoint listener with the given configuration

Declaration

public URLEndpointListener(URLEndpointListenerConfiguration config)

Parameters

Type	Name	Description
URLEndpointListenerConfiguration	config	The configuration details to use

Properties

Config

The configuration object used for creating the listener.

Declaration

public URLEndpointListenerConfiguration Config { get; }

Property Value

Type	Description
URLEndpointListenerConfiguration

Remarks

NOTE: This is an enterprise edition feature

Port

The port that the listener is listening to. If the listener is not started, the port property will be zero.

Declaration

public ushort Port { get; }

Property Value

Type	Description
System.UInt16

Remarks

NOTE: This is an enterprise edition feature

Status

The current connection status of the listener.

Declaration

public ConnectionStatus Status { get; }

Property Value

Type	Description
ConnectionStatus

Remarks

NOTE: This is an enterprise edition feature

TlsIdentity

The TLS identity used by the listener to provide TLS communication. If the listener is not started or the TLS is disabled, the property value will be null.

Declaration

public TLSIdentity TlsIdentity { get; set; }

Property Value

Type	Description
TLSIdentity

Urls

The possible URLs of the listener. If the listener is not started, the urls property will be null.

Declaration

public List<Uri> Urls { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.Uri>

Remarks

NOTE: This is an enterprise edition feature

Methods

Dispose()

Declaration

public void Dispose()

Finalize()

The finalizer

Declaration

protected void Finalize()

Start()

Starts the listener.

Declaration

public void Start()

Exceptions

Type	Condition
CouchbaseLiteException	CouchbaseLiteException will be thrown when the listener cannot be started. The most common error would be that the configured port has already been used.

Stop()

Stop the listener.

Declaration

public void Stop()

Implements

System.IDisposable