Couchbase Lite C++
Couchbase Lite C++ API
Loading...
Searching...
No Matches
cbl::Endpoint Class Reference

The replication endpoint representing the location of a database to replicate with. More...

#include <cbl++/Replicator.hh>

Static Public Member Functions

static Endpoint urlEndpoint (std::string_view url)
 Creates a URL endpoint with a given URL.
static Endpoint databaseEndpoint (Database db)
 Creates a database endpoint with another local database.

Protected Member Functions

CBLEndpoint *_Nullable ref () const

Friends

class ReplicatorConfiguration

Detailed Description

The replication endpoint representing the location of a database to replicate with.

Member Function Documentation

◆ databaseEndpoint()

Endpoint cbl::Endpoint::databaseEndpoint ( Database db)
inlinestatic

Creates a database endpoint with another local database.

(Enterprise Edition only.)

◆ ref()

CBLEndpoint *_Nullable cbl::Endpoint::ref ( ) const
inlineprotected

◆ urlEndpoint()

Endpoint cbl::Endpoint::urlEndpoint ( std::string_view url)
inlinestatic

Creates a URL endpoint with a given URL.

The URL's scheme must be ws or wss, it must of course have a valid hostname, and its path must be the name of the database on that server.

The port can be omitted; it defaults to 80 for ws and 443 for wss. For example: wss://example.org/dbname.

Parameters
urlThe url.

◆ ReplicatorConfiguration

friend class ReplicatorConfiguration
friend

The documentation for this class was generated from the following file: