Show / Hide Table of Contents

Class MessageEndpointListenerConfiguration

A class for configuring a new MessageEndpointListener instance

Inheritance
System.Object
MessageEndpointListenerConfiguration
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 MessageEndpointListenerConfiguration
Remarks

NOTE: This is an enterprise edition feature

Constructors

| Improve this Doc View Source

MessageEndpointListenerConfiguration(Database, ProtocolType)

[DEPRECATED] Constructs a new configuration object

Declaration
[Obsolete("MessageEndpointListenerConfiguration(Database, ProtocolType) is deprecated, please use MessageEndpointListenerConfiguration(List<Collection>, ProtocolType).")]
public MessageEndpointListenerConfiguration(Database database, ProtocolType protocolType)
Parameters
Type Name Description
Database database

The local database to operate on

ProtocolType protocolType

The protocol type that connections to the listener use

Remarks

NOTE: This is an enterprise edition feature

| Improve this Doc View Source

MessageEndpointListenerConfiguration(IReadOnlyList<Collection>, ProtocolType)

Constructs a new configuration object

Declaration
public MessageEndpointListenerConfiguration(IReadOnlyList<Collection> collections, ProtocolType protocolType)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyList<Collection> collections

The local collections to operate on

ProtocolType protocolType

The protocol type that connections to the listener use

Remarks

NOTE: This is an enterprise edition feature

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

| Improve this Doc View Source

Collections

The list of collections that the listener should serve as the server side of replication

Declaration
public IReadOnlyList<Collection> Collections { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<Collection>
| Improve this Doc View Source

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

| Improve this Doc View Source

ProtocolType

Gets the protocol type that connections to this listener use (note: Must match the protocol type on the corresponding MessageEndpoint on the other side)

Declaration
public ProtocolType ProtocolType { get; }
Property Value
Type Description
ProtocolType
Remarks

NOTE: This is an enterprise edition feature

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX