Package com.couchbase.lite.internal.core

Class C4Replicator

java.lang.Object

com.couchbase.lite.internal.core.C4NativePeer

com.couchbase.lite.internal.core.C4Replicator

All Implemented Interfaces:

java.lang.AutoCloseable

public class C4Replicator
extends C4NativePeer

There are two things that need protection in the class:

1. Messages sent to it from native code: This object proxies those messages out to various listeners. Until a replicator object is removed from the REVERSE_LOOKUP_TABLE forwarding such a message must work.
2. Calls to the native object: These should work as long as the peer handle is non-zero. This object must be careful never to forward a call to a native object once that object has been freed.

Instances of this class are created using static factory methods

WARNING! This class and its members are referenced by name, from native code.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AUTH_TYPE_BASIC
static java.lang.String	AUTH_TYPE_CLIENT_CERT
static java.lang.String	AUTH_TYPE_FACEBOOK
static java.lang.String	AUTH_TYPE_OPEN_ID_CONNECT
static java.lang.String	AUTH_TYPE_SESSION
static java.lang.String	C4_REPLICATOR_SCHEME_2
static java.lang.String	C4_REPLICATOR_TLS_SCHEME_2
static java.lang.String	MESSAGE_SCHEME
static int	PROGRESS_OVERALL
static int	PROGRESS_PER_ATTACHMENT
static int	PROGRESS_PER_DOC
static java.lang.String	REPLICATOR_AUTH_CLIENT_CERT
static java.lang.String	REPLICATOR_AUTH_CLIENT_CERT_KEY
static java.lang.String	REPLICATOR_AUTH_PASSWORD
static java.lang.String	REPLICATOR_AUTH_TOKEN
static java.lang.String	REPLICATOR_AUTH_TYPE
static java.lang.String	REPLICATOR_AUTH_USER_NAME
static java.lang.String	REPLICATOR_CHECKPOINT_INTERVAL
static java.lang.String	REPLICATOR_HEARTBEAT_INTERVAL
static java.lang.String	REPLICATOR_OPTION_AUTHENTICATION
static java.lang.String	REPLICATOR_OPTION_CHANNELS
static java.lang.String	REPLICATOR_OPTION_COOKIES
static java.lang.String	REPLICATOR_OPTION_DISABLE_DELTAS
static java.lang.String	REPLICATOR_OPTION_DOC_IDS
static java.lang.String	REPLICATOR_OPTION_ENABLE_AUTO_PURGE
static java.lang.String	REPLICATOR_OPTION_EXTRA_HEADERS
static java.lang.String	REPLICATOR_OPTION_FILTER
static java.lang.String	REPLICATOR_OPTION_FILTER_PARAMS
static java.lang.String	REPLICATOR_OPTION_MAX_RETRIES
static java.lang.String	REPLICATOR_OPTION_MAX_RETRY_INTERVAL
static java.lang.String	REPLICATOR_OPTION_NO_INCOMING_CONFLICTS
static java.lang.String	REPLICATOR_OPTION_OUTGOING_CONFLICTS
static java.lang.String	REPLICATOR_OPTION_PINNED_SERVER_CERT
static java.lang.String	REPLICATOR_OPTION_PROGRESS_LEVEL
static java.lang.String	REPLICATOR_OPTION_PROXY_SERVER
static java.lang.String	REPLICATOR_OPTION_REMOTE_DB_UNIQUE_ID
static java.lang.String	REPLICATOR_OPTION_ROOT_CERTS
static java.lang.String	REPLICATOR_OPTION_SELF_SIGNED_SERVER_CERT
static java.lang.String	REPLICATOR_OPTION_SKIP_DELETED
static java.lang.String	SOCKET_OPTION_WS_PROTOCOLS
static java.lang.String	WEBSOCKET_SCHEME
static java.lang.String	WEBSOCKET_SECURE_CONNECTION_SCHEME

Method Summary

Modifier and Type	Method	Description
void	close()
java.util.Set<java.lang.String>	getPendingDocIDs()
C4ReplicatorStatus	getStatus()
boolean	isDocumentPending(java.lang.String docId)
void	setHostReachable(boolean reachable)
void	setOptions(byte[] options)
void	setProgressLevel(int level)
void	start(boolean restart)
void	stop()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WEBSOCKET_SCHEME

public static final java.lang.String WEBSOCKET_SCHEME

See Also:

Constant Field Values

WEBSOCKET_SECURE_CONNECTION_SCHEME

public static final java.lang.String WEBSOCKET_SECURE_CONNECTION_SCHEME

See Also:

Constant Field Values

MESSAGE_SCHEME

public static final java.lang.String MESSAGE_SCHEME

See Also:

Constant Field Values

C4_REPLICATOR_SCHEME_2

public static final java.lang.String C4_REPLICATOR_SCHEME_2

See Also:

Constant Field Values

C4_REPLICATOR_TLS_SCHEME_2

public static final java.lang.String C4_REPLICATOR_TLS_SCHEME_2

See Also:

Constant Field Values

REPLICATOR_OPTION_DOC_IDS

public static final java.lang.String REPLICATOR_OPTION_DOC_IDS

See Also:

Constant Field Values

REPLICATOR_OPTION_CHANNELS

public static final java.lang.String REPLICATOR_OPTION_CHANNELS

See Also:

Constant Field Values

REPLICATOR_OPTION_FILTER

public static final java.lang.String REPLICATOR_OPTION_FILTER

See Also:

Constant Field Values

REPLICATOR_OPTION_FILTER_PARAMS

public static final java.lang.String REPLICATOR_OPTION_FILTER_PARAMS

See Also:

Constant Field Values

REPLICATOR_OPTION_SKIP_DELETED

public static final java.lang.String REPLICATOR_OPTION_SKIP_DELETED

See Also:

Constant Field Values

REPLICATOR_OPTION_NO_INCOMING_CONFLICTS

public static final java.lang.String REPLICATOR_OPTION_NO_INCOMING_CONFLICTS

See Also:

Constant Field Values

REPLICATOR_OPTION_OUTGOING_CONFLICTS

public static final java.lang.String REPLICATOR_OPTION_OUTGOING_CONFLICTS

See Also:

Constant Field Values

REPLICATOR_CHECKPOINT_INTERVAL

public static final java.lang.String REPLICATOR_CHECKPOINT_INTERVAL

See Also:

Constant Field Values

REPLICATOR_OPTION_REMOTE_DB_UNIQUE_ID

public static final java.lang.String REPLICATOR_OPTION_REMOTE_DB_UNIQUE_ID

See Also:

Constant Field Values

REPLICATOR_OPTION_PROGRESS_LEVEL

public static final java.lang.String REPLICATOR_OPTION_PROGRESS_LEVEL

See Also:

Constant Field Values

REPLICATOR_OPTION_DISABLE_DELTAS

public static final java.lang.String REPLICATOR_OPTION_DISABLE_DELTAS

See Also:

Constant Field Values

REPLICATOR_OPTION_MAX_RETRIES

public static final java.lang.String REPLICATOR_OPTION_MAX_RETRIES

See Also:

Constant Field Values

REPLICATOR_OPTION_MAX_RETRY_INTERVAL

public static final java.lang.String REPLICATOR_OPTION_MAX_RETRY_INTERVAL

See Also:

Constant Field Values

REPLICATOR_OPTION_ENABLE_AUTO_PURGE

public static final java.lang.String REPLICATOR_OPTION_ENABLE_AUTO_PURGE

See Also:

Constant Field Values

REPLICATOR_OPTION_ROOT_CERTS

public static final java.lang.String REPLICATOR_OPTION_ROOT_CERTS

See Also:

Constant Field Values

REPLICATOR_OPTION_PINNED_SERVER_CERT

public static final java.lang.String REPLICATOR_OPTION_PINNED_SERVER_CERT

See Also:

Constant Field Values

REPLICATOR_OPTION_SELF_SIGNED_SERVER_CERT

public static final java.lang.String REPLICATOR_OPTION_SELF_SIGNED_SERVER_CERT

See Also:

Constant Field Values

REPLICATOR_OPTION_EXTRA_HEADERS

public static final java.lang.String REPLICATOR_OPTION_EXTRA_HEADERS

See Also:

Constant Field Values

REPLICATOR_OPTION_COOKIES

public static final java.lang.String REPLICATOR_OPTION_COOKIES

See Also:

Constant Field Values

REPLICATOR_OPTION_AUTHENTICATION

public static final java.lang.String REPLICATOR_OPTION_AUTHENTICATION

See Also:

Constant Field Values

REPLICATOR_OPTION_PROXY_SERVER

public static final java.lang.String REPLICATOR_OPTION_PROXY_SERVER

See Also:

Constant Field Values

REPLICATOR_HEARTBEAT_INTERVAL

public static final java.lang.String REPLICATOR_HEARTBEAT_INTERVAL

See Also:

Constant Field Values

SOCKET_OPTION_WS_PROTOCOLS

public static final java.lang.String SOCKET_OPTION_WS_PROTOCOLS

See Also:

Constant Field Values

REPLICATOR_AUTH_TYPE

public static final java.lang.String REPLICATOR_AUTH_TYPE

See Also:

Constant Field Values

REPLICATOR_AUTH_USER_NAME

public static final java.lang.String REPLICATOR_AUTH_USER_NAME

See Also:

Constant Field Values

REPLICATOR_AUTH_PASSWORD

public static final java.lang.String REPLICATOR_AUTH_PASSWORD

See Also:

Constant Field Values

REPLICATOR_AUTH_CLIENT_CERT

public static final java.lang.String REPLICATOR_AUTH_CLIENT_CERT

See Also:

Constant Field Values

REPLICATOR_AUTH_CLIENT_CERT_KEY

public static final java.lang.String REPLICATOR_AUTH_CLIENT_CERT_KEY

See Also:

Constant Field Values

REPLICATOR_AUTH_TOKEN

public static final java.lang.String REPLICATOR_AUTH_TOKEN

See Also:

Constant Field Values

AUTH_TYPE_BASIC

public static final java.lang.String AUTH_TYPE_BASIC

See Also:

Constant Field Values

AUTH_TYPE_SESSION

public static final java.lang.String AUTH_TYPE_SESSION

See Also:

Constant Field Values

AUTH_TYPE_OPEN_ID_CONNECT

public static final java.lang.String AUTH_TYPE_OPEN_ID_CONNECT

See Also:

Constant Field Values

AUTH_TYPE_FACEBOOK

public static final java.lang.String AUTH_TYPE_FACEBOOK

See Also:

Constant Field Values

AUTH_TYPE_CLIENT_CERT

public static final java.lang.String AUTH_TYPE_CLIENT_CERT

See Also:

Constant Field Values

PROGRESS_OVERALL

public static final int PROGRESS_OVERALL

See Also:

Constant Field Values

PROGRESS_PER_DOC

public static final int PROGRESS_PER_DOC

See Also:

Constant Field Values

PROGRESS_PER_ATTACHMENT

public static final int PROGRESS_PER_ATTACHMENT

See Also:

Constant Field Values

Method Detail

start

public void start(boolean restart)

stop

public void stop()

close

@CallSuper
public void close()

setOptions

public void setOptions(@Nullable
                       byte[] options)

getStatus

@Nullable
public C4ReplicatorStatus getStatus()

isDocumentPending

public boolean isDocumentPending(java.lang.String docId)
                          throws LiteCoreException

Throws:

LiteCoreException

getPendingDocIDs

@NonNull
public java.util.Set<java.lang.String> getPendingDocIDs()
                                                 throws LiteCoreException

Throws:

LiteCoreException

setProgressLevel

public void setProgressLevel(int level)
                      throws LiteCoreException

Throws:

LiteCoreException

setHostReachable

public void setHostReachable(boolean reachable)

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class C4NativePeer