c4Replicator.h

Go to the documentation of this file.

//
// c4Replicator.h
//
// Copyright 2017-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
#include "c4ReplicatorTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
CBL_CORE_API bool c4repl_isValidDatabaseName(C4String dbName) C4API;
 
NODISCARD CBL_CORE_API bool c4repl_isValidRemote(C4Address remoteAddress, C4String remoteDatabaseName,
                                                 C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4address_fromURL(C4String url, C4Address* address, C4String* C4NULLABLE dbName) C4API;
 
CBL_CORE_API C4StringResult c4address_toURL(C4Address address) C4API;
 
 
NODISCARD CBL_CORE_API C4Replicator* c4repl_new(C4Database* db, C4Address remoteAddress, C4String remoteDatabaseName,
                                                C4ReplicatorParameters params, C4String logPrefix,
                                                C4Error* C4NULLABLE outError) C4API;
 
#ifdef COUCHBASE_ENTERPRISE
NODISCARD CBL_CORE_API C4Replicator* c4repl_newLocal(C4Database* db, C4Database* otherLocalDB,
                                                     C4ReplicatorParameters params, C4String logPrefix,
                                                     C4Error* C4NULLABLE outError) C4API;
#endif
 
NODISCARD CBL_CORE_API C4Replicator* c4repl_newWithSocket(C4Database* db, C4Socket* openSocket,
                                                          C4ReplicatorParameters params, C4String logPrefix,
                                                          C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API void c4repl_start(C4Replicator* repl, bool reset) C4API;
 
CBL_CORE_API void c4repl_stop(C4Replicator* repl) C4API;
 
NODISCARD CBL_CORE_API bool c4repl_retry(C4Replicator* repl, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API void c4repl_setHostReachable(C4Replicator* repl, bool reachable) C4API;
 
CBL_CORE_API void c4repl_setSuspended(C4Replicator* repl, bool suspended) C4API;
 
CBL_CORE_API void c4repl_setOptions(C4Replicator* repl, C4Slice optionsDictFleece) C4API;
 
CBL_CORE_API C4ReplicatorStatus c4repl_getStatus(C4Replicator* repl) C4API;
 
CBL_CORE_API C4Slice c4repl_getResponseHeaders(C4Replicator* repl) C4API;
 
CBL_CORE_API C4SliceResult c4repl_getPendingDocIDs(C4Replicator* repl, C4CollectionSpec spec,
                                                   C4Error* C4NULLABLE outErr) C4API;
 
NODISCARD CBL_CORE_API bool c4repl_isDocumentPending(C4Replicator* repl, C4String docID, C4CollectionSpec spec,
                                                     C4Error* C4NULLABLE outErr) C4API;
 
 
NODISCARD CBL_CORE_API C4Cert* c4repl_getPeerTLSCertificate(C4Replicator* repl, C4Error* C4NULLABLE outErr) C4API;
 
NODISCARD CBL_CORE_API bool c4repl_setProgressLevel(C4Replicator* repl, C4ReplicatorProgressLevel level,
                                                    C4Error* C4NULLABLE outErr) C4API;
 
 
#pragma mark - COOKIES:
 
 
NODISCARD CBL_CORE_API bool c4db_setCookie(C4Database* db, C4String setCookieHeader, C4String fromHost,
                                           C4String fromPath, bool acceptParentDomain,
                                           C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4StringResult c4db_getCookies(C4Database* db, C4Address request, C4Error* C4NULLABLE error) C4API;
 
CBL_CORE_API void c4db_clearCookies(C4Database* db) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END