Show / Hide Table of Contents

Namespace Couchbase.Lite.P2P

Classes

Certificate

A class for handling X509 certificates (note that the only public facing items are some constants)

ClientCertificateAuthenticator

A class designed to perform replication authentication using a given TLSIdentity instance (i.e. client certificate authentication)

ConnectionStatus

ConnectionStatus provides the information about the connections from the replicators to the listener.

ListenerCertificateAuthenticator

ListenerCertificateAuthenticator provides certificate authentication for authenticating clients.

ListenerPasswordAuthenticator

ListenerPasswordAuthenticator provides password types authentication such as the BASIC authentication that we currently support.

Message

This class encapsulates the concept of a message, which is an object that can be represented as a series of bytes for abstract transport

MessageEndpoint

An endpoint that will communicate over an arbitrary line of communication that is implemented in application space

MessageEndpointListener

A listener class that accepts incoming replicators that use the MessageEndpoint class as their endpoint. Discovery and initial connection must be handled by the application, but once that is finished the connection can then be passed to the listener via the Accept(IMessageEndpointConnection) method.

MessageEndpointListenerChangedEventArgs

The event arguments for the AddChangeListener(EventHandler<MessageEndpointListenerChangedEventArgs>) method

MessageEndpointListenerConfiguration

A class for configuring a new MessageEndpointListener instance

MessagingException

A class representing an error during transport of a MessageEndpoint based replication

TLSIdentity

TLSIdentity represents the identity information (Key pair and Certificates) used for setting up TLS Communication.

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.

URLEndpointListenerConfiguration

A class for configuring a new URLEndpointListener instance

Interfaces

IListenerAuthenticator

An opaque authenticator interface which will be implemented by the actual authenticator classes. We support two types of the authenticator in the Hydrogen release including ListenerPasswordAuthenticator and ListenerCertificateAuthenticator.

IMessageEndpointConnection

This interface represents the "send" portion of a replication that is based on the MessageEndpoint variant of endpoints. It contains methods to open, close, and send data. It must be implemented by the application.

IMessageEndpointDelegate

A helper interface for MessageEndpoint which contains functionality for creating a connection to be used in a replication over custom transport

IReplicatorConnection

This interface is the counterpart to IMessageEndpointConnection. While IMessageEndpointConnection communicates outgoing events, this interface is for signaling incoming events. A typical setup is to have incoming data via application logic, which then calls to the methods of this interface, which is implemented and provided by Couchbase Lite.

Enums

ProtocolType

The type of protocol that the P2P framework will be implementing

Delegates

ListenerCertificateAuthenticator.ListenerCertificateAuthenticatorCallback

Server to verify the certificate chain received from the client callback.

ListenerPasswordAuthenticator.ListenerPasswordAuthenticatorCallback

Server to authenticate the username and password for the ListenerPasswordAuthenticator callback.

In This Article
Back to top Generated by DocFX