Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://couchbase.github.io/couchbase-lite-core/C/html/group___replicator.html below:

LiteCore: Replicator

HTTP Basic (the default)

TLS client cert.

Facebook auth token.

OpenID Connect token.

SG session cookie.

HTTP proxy (using CONNECT method)

HTTPS proxy (using CONNECT method)

Use no proxy (overrides system setting)

SOCKS proxy.

TLS client certificate (value platform-dependent)

Client cert's private key (data)

Use challenge auth instead of preemptive auth for basic auth, default is false (bool); \ Implemented by BuiltInWebSocket.

Password for basic auth (string)

Session cookie or auth token (string)

Auth type; see [2] (string)

User name for basic auth (string)

How often to checkpoint, in seconds (number)

Data compression level, 0..9.

Interval in secs to send a keepalive ping.

Auth settings (Dict); see [1].

Enables auto purge; default is true (bool)

SG channel names (string[])

HTTP Cookie header value (string)

Disables delta sync (bool)

Disables property decryption (bool)

Docs to replicate (string[])

Extra HTTP headers (string[])

Pull filter name (string)

Pull filter params (Dict[string])

Max number of retry attempts (int)

Max delay betw retries (secs)

Reject incoming conflicts (bool)

Only accept self signed server certs (for P2P, bool)

Cert or public key (data)

Proxy settings (Dict); see [3]].

Stable ID for remote db with unstable URL (string)

Trusted root certs (data)

Don't push/pull tombstones (bool)

Proxy auth (Dict); see above.

Proxy hostname (string)

Proxy port number (integer)

Proxy type; see [4] (string)

Specific network interface (name or IP address) used for connecting to the remote server.

Sec-WebSocket-Protocol header value.

Callback a client can register, to hear about the status of blobs.

Callback a client can register, to hear about the replication status of documents.

By default, only errors will be reported via this callback. To also receive callbacks for successfully completed documents, set the kC4ReplicatorOptionProgressLevel option to a value greater than zero.

Callback a client can register, to get progress information.

This will be called on arbitrary background threads, and should not block.

Callback that can choose to reject an incoming pulled revision, or stop a local revision from being pushed, by returning false.

(Note: In the case of an incoming revision, no flags other than 'deletion' and 'hasAttachments' will be set.)

Finished, or got a fatal error.

Connection failed, but waiting to retry. *‍/.

Connection is in progress.

Continuous replicator has caught up and is waiting for changes.

Connected and actively working.

Stopping or going offline.

Callback about completion and estimated total (C4ReplicatorStatusChangedCallback)

Callback for every document replicated (C4ReplicatorDocumentsEndedCallback)

Callback for every document and attachment replicated (C4ReplicatorBlobProgressCallback)

If true, will automatically reconnect when offline.

If false, it's not possible to connect to the host.

If true, will not connect until unsuspended.

A simple URL parser that populates a C4Address from a URL string.

The fields of the address will point inside the url string.

Note

This function is thread-safe.

Parameters

url The URL to be parsed. address On sucess, the fields of the struct this points to will be populated with the address components. This that are slices will point into the appropriate substrings of url. dbName If non-NULL, then on success this slice will point to the last path component of url; address->path will not include this component.

Returns

True on success, false on failure.

Removes all cookies from the database's cookie store.

Note

The caller must use a lock for Database when this function is called.

Locates any saved HTTP cookies relevant to the given request, and returns them as a string that can be used as the value of a "Cookie:" header.

Note

The caller must use a lock for Database when this function is called.

Takes the value of a "Set-Cookie:" header, received from the given host, from an HTTP request with the given path, and saves the cookie into the database's cookie store.

(Persistent cookies are saved as metadata in the database file until they expire. Session cookies are kept in memory, until the last C4Database handle to the given database is closed.)

Note

The caller must use a lock for Database when this function is called.

Parameters

db The C4Databaser instance. setCookieHeader The "Set-Cookie" header. fromHost The host address of the request. fromPath The path of the request. acceptParentDomain Whether to allow the "Domain" property of the cookie to be a parent domain of the host address. It should match the option, kC4ReplicatorOptionAcceptParentDomainCookies, in C4ReplicatorParameters. outError Records error information, if any.

Returns

true if the cookie is successfully saved..

Gets the TLS certificate, if any, that was sent from the remote server (NOTE: Only functions when using BuiltInWebSocket)

Note

This function is thread-safe.

Gets a fleece encoded list of IDs of documents who have revisions pending push.

This API is a snapshot and results may change between the time the call was made and the time the call returns.

Note

This function is thread-safe.

Parameters

repl The C4Replicator instance. spec The collection spec outErr On failure, error information will be written here if non-NULL.

Returns

A fleece encoded array of document IDs, each of which has one or more pending revisions. If none are pending, nullslice is returned (note that an error condition will return nullslice with the outErr code set to non-zero)

Returns the HTTP response headers as a Fleece-encoded dictionary.

Note

This function is thread-safe.

Returns the current state of a replicator.

Note

This function is thread-safe.

Checks if the document with the given ID has revisions pending push.

This API is a snapshot and results may change between the time the call was made and the time the call returns.

Note

This function is thread-safe.

Parameters

repl The C4Replicator instance. docID The ID of the document to check spec The collection the docID belongs to. outErr On failure, error information will be written here if non-NULL.

Returns

true if the document has one or more revisions pending, false otherwise (note that an error condition will return false with the outErr code set to non-zero)

Checks whether a database name is valid, for purposes of appearing in a replication URL.

Checks whether the destination of a replication is valid.

(c4repl_new makes the same checks; this function is exposed so CBL can fail sooner.)

Creates a new networked replicator.

Note

The caller must use a lock for Database when this function is called.

Parameters

db The local database. remoteAddress The address of the remote server. remoteDatabaseName The name of the database at the remote address. params Replication parameters (see above.) logPrefix prefix to the loggingClassName of returned C4Replicator. outError Error, if replication can't be created.

Returns

The newly created replicator, or NULL on error.

Creates a new replicator from an already-open C4Socket.

This is for use by listeners that accept incoming connections, wrap them by calling c4socket_fromNative(), then start a passive replication to service them.

Note

The caller must use a lock for Database when this function is called.

Parameters

db The local database. openSocket An already-created C4Socket. params Replication parameters. Will usually use kC4Passive modes. logPrefix prefix to the loggingClassName of returned C4Replicator. outError Error, if replication can't be created.

Returns

The newly created replicator, or NULL on error.

Tells a replicator that's in the offline state to reconnect immediately.

Note

This function is thread-safe.

Parameters

repl The replicator. outError On failure, error information is stored here.

Returns

True if the replicator will reconnect, false if it won't.

Informs the replicator whether it's considered possible to reach the remote host with the current network configuration.

The default value is true. This only affects the replicator's behavior while it's in the Offline state: Setting it to false will cancel any pending retry and prevent future automatic retries. Setting it back to true will initiate an immediate retry.

Note

This function is thread-safe.

Sets the replicator's options dictionary.

The changes will take effect next time the replicator connects.

Note

This function is thread-safe.

Sets the progress level of the replicator, indicating what information should be provided via callback.

Note

The caller must use a lock for Replicator when this function is called.

Parameters

repl The C4Replicator instance. level The progress level to set on the replicator outErr Records error information, if any.

Returns

true if the progress level was set, false if there was an error.

Puts the replicator in or out of "suspended" state.

Setting suspended=true causes the replicator to disconnect and enter Offline state; it will not attempt to reconnect while it's suspended. Setting suspended=false causes the replicator to attempt to reconnect, if it was connected when suspended, and is still in Offline state.

Note

This function is thread-safe.

Tells a replicator to start.

Ignored if it's not in the Stopped state.

Note

This function is thread-safe.

Do not call this function while a transaction is open on the same database as it can deadlock when repl tries to acquire the database.

Parameters

repl The C4Replicator instance. reset If true, the replicator will reset its checkpoint and start replication from the beginning

Tells a replicator to stop.

Ignored if in the Stopped state.

Note

This function is thread-safe.

For convenience, an array of C strings naming the C4ReplicatorActivityLevel values.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4