C4ListenerConfig Struct Reference

Configuration for a C4Listener. More...

#include <c4ListenerTypes.h>

Data Fields
uint16_t	port
	TCP port to listen on.
C4String	networkInterface
	name or address of interface to listen on; else all
C4ListenerAPIs	apis
	Which API(s) to enable.
C4TLSConfig *	tlsConfig
	TLS configuration, or NULL for no TLS.
C4ListenerHTTPAuthCallback	httpAuthCallback
	Callback for HTTP auth.
void *	callbackContext
	Client value passed to HTTP auth callback.
C4String	directory
	Directory where newly-PUT databases will be created.
bool	allowCreateDBs
	If true, "PUT /db" is allowed.
bool	allowDeleteDBs
	If true, "DELETE /db" is allowed.
bool	allowCreateCollections
	If true, "PUT /db.scope.coll" is allowed.
bool	allowDeleteCollections
	If true, "DELETE /db.scope.coll" is allowed.
bool	allowPush
	Allow peers to push changes to local db.
bool	allowPull
	Allow peers to pull changes from local db.
bool	enableDeltaSync
	Enable document-deltas optimization.

Detailed Description

Configuration for a C4Listener.

Field Documentation

allowCreateCollections

bool C4ListenerConfig::allowCreateCollections

If true, "PUT /db.scope.coll" is allowed.

allowCreateDBs

bool C4ListenerConfig::allowCreateDBs

If true, "PUT /db" is allowed.

allowDeleteCollections

bool C4ListenerConfig::allowDeleteCollections

If true, "DELETE /db.scope.coll" is allowed.

allowDeleteDBs

bool C4ListenerConfig::allowDeleteDBs

If true, "DELETE /db" is allowed.

allowPull

bool C4ListenerConfig::allowPull

Allow peers to pull changes from local db.

allowPush

bool C4ListenerConfig::allowPush

Allow peers to push changes to local db.

apis

C4ListenerAPIs C4ListenerConfig::apis

Which API(s) to enable.

callbackContext

void* C4ListenerConfig::callbackContext

Client value passed to HTTP auth callback.

directory

C4String C4ListenerConfig::directory

Directory where newly-PUT databases will be created.

enableDeltaSync

bool C4ListenerConfig::enableDeltaSync

Enable document-deltas optimization.

httpAuthCallback

C4ListenerHTTPAuthCallback C4ListenerConfig::httpAuthCallback

Callback for HTTP auth.

networkInterface

C4String C4ListenerConfig::networkInterface

name or address of interface to listen on; else all

port

uint16_t C4ListenerConfig::port

TCP port to listen on.

tlsConfig

C4TLSConfig* C4ListenerConfig::tlsConfig

TLS configuration, or NULL for no TLS.

---

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

• c4ListenerTypes.h