Couchbase Lite C
Couchbase Lite C API
Loading...
Searching...
No Matches
CBLURLEndpointListenerConfiguration Struct Reference

The configuration for the URLEndpointListener. More...

#include <cbl/CBLURLEndpointListener.h>

Data Fields

CBLCollection ** collections
 (Required) The collections available for replication .
size_t collectionCount
 (Required) The number of collections (Required).
uint16_t port
 The port that the listener will listen to.
FLString networkInterface
 The network interface in the form of the IP Address or network interface name such as en0 that the listener will listen to.
bool disableTLS
 Disable TLS communication.
CBLTLSIdentity *_cbl_nullable tlsIdentity
 TLSIdentity required for TLS communication.
CBLListenerAuthenticator *_cbl_nullable authenticator
 The authenticator used by the listener to authenticate clients.
bool enableDeltaSync
 Allow delta sync when replicating with the listener.
bool readOnly
 Allow only pull replication to pull changes from the listener.

Detailed Description

The configuration for the URLEndpointListener.

Field Documentation

◆ authenticator

CBLListenerAuthenticator* _cbl_nullable CBLURLEndpointListenerConfiguration::authenticator

The authenticator used by the listener to authenticate clients.

◆ collectionCount

size_t CBLURLEndpointListenerConfiguration::collectionCount

(Required) The number of collections (Required).

◆ collections

CBLCollection* * CBLURLEndpointListenerConfiguration::collections

(Required) The collections available for replication .

◆ disableTLS

bool CBLURLEndpointListenerConfiguration::disableTLS

Disable TLS communication.

The default value is false which means that TLS will be enabled by default.

◆ enableDeltaSync

bool CBLURLEndpointListenerConfiguration::enableDeltaSync

Allow delta sync when replicating with the listener.

The default value is false.

◆ networkInterface

FLString CBLURLEndpointListenerConfiguration::networkInterface

The network interface in the form of the IP Address or network interface name such as en0 that the listener will listen to.

The default value is null slice which means that the listener will listen to all network interfaces.

◆ port

uint16_t CBLURLEndpointListenerConfiguration::port

The port that the listener will listen to.

Default value is zero which means that the listener will automatically select an available port to listen to when the listener is started.

◆ readOnly

bool CBLURLEndpointListenerConfiguration::readOnly

Allow only pull replication to pull changes from the listener.

The default value is false.

◆ tlsIdentity

CBLTLSIdentity* _cbl_nullable CBLURLEndpointListenerConfiguration::tlsIdentity

TLSIdentity required for TLS communication.


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