Show / Hide Table of Contents

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 .

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, IStoppable
Remarks

NOTE: This is an enterprise edition feature

Constructors

| Improve this Doc View Source

URLEndpointListener(URLEndpointListenerConfiguration)

Declaration
public URLEndpointListener(URLEndpointListenerConfiguration config)
Parameters
Type Name Description
URLEndpointListenerConfiguration config

Properties

| Improve this Doc View Source

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

| Improve this Doc View Source

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

| Improve this Doc View Source

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

| Improve this Doc View Source

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
| Improve this Doc View Source

Urls

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

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

| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Finalize()

Declaration
protected void Finalize()
| Improve this Doc View Source

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.

| Improve this Doc View Source

Stop()

Stop the listener.

Declaration
public void Stop()

Implements

System.IDisposable
  • Improve this Doc
  • View Source
Back to top Generated by DocFX