Show / Hide Table of Contents

Interface 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.

Namespace: Couchbase.Lite.P2P
Assembly: Couchbase.Lite.dll
Syntax
public interface IMessageEndpointConnection
Remarks

NOTE: This is an enterprise edition feature

Methods

| Improve this Doc View Source

Close(Exception)

Closes the connection to the remote endpoint

Declaration
Task Close(Exception error)
Parameters
Type Name Description
Exception error

The error that caused the replication to close, if any

Returns
Type Description
Task

A task that can be awaited to determine the end of the close

| Improve this Doc View Source

Open(IReplicatorConnection)

Opens a connection to the remote endpoint, linking it with the given IReplicatorConnection

Declaration
Task Open(IReplicatorConnection connection)
Parameters
Type Name Description
IReplicatorConnection connection

The counterpart in the send/receive relationship which is used to signal the replication process of certain key events

Returns
Type Description
Task

A task that can be awaited to determine the end of the open

| Improve this Doc View Source

Send(Message)

Sends a message to the remote endpoint

Declaration
Task Send(Message message)
Parameters
Type Name Description
Message message

The message to send

Returns
Type Description
Task

A task that can be awaited to determine the end of the send

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