Class ReplicatorConfiguration

A class representing configuration options for a Replicator

Inheritance
System.Object
ReplicatorConfiguration
Implements
System.IEquatable<ReplicatorConfiguration>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Couchbase.Lite.Sync
Assembly: Couchbase.Lite.dll
Syntax
public sealed class ReplicatorConfiguration : IEquatable<ReplicatorConfiguration>

Fields

| Improve this Doc View Source

IEndpoint

Gets the target to replicate with (either Database or System.Uri

Declaration
public required IEndpoint
Field Value
Type Description
required

Properties

| Improve this Doc View Source

AcceptOnlySelfSignedServerCertificate

Get or set the way that the replicator will validate TLS certificates. This property will be overriden if the PinnedServerCertificate property is set. Default value is DefaultReplicatorSelfSignedCertificateOnly

Declaration
public bool AcceptOnlySelfSignedServerCertificate { get; set; }
Property Value
Type Description
System.Boolean
Remarks

NOTE: This is an enterprise edition feature

| Improve this Doc View Source

AcceptParentDomainCookies

Gets or sets whether a cookie can be set on a parent domain of the host that issued it (i.e. foo.bar.com can set a cookie for all of bar.com). This is only recommended if the host issuing the cookie is well trusted.

Declaration
public bool AcceptParentDomainCookies { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Authenticator

Gets or sets the class which will authenticate the replication

Declaration
public Authenticator Authenticator { get; set; }
Property Value
Type Description
Authenticator
| Improve this Doc View Source

Continuous

Gets or sets whether the Replicator should stay active indefinitely. The default is false Default value is DefaultReplicatorContinuous

Declaration
public bool Continuous { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

EnableAutoPurge

Gets or sets the value to enable/disable the auto-purge feature.

  • The default value is true which means that the document will be automatically purged by the pull replicator when the user loses access to the document from both removed and revoked scenarios.
  • If set the property to false, AutoPurge is disabled, the replicator will notify the registered DocumentReplicationListener AddDocumentReplicationListener(EventHandler<DocumentReplicationEventArgs>) with an "access removed" event AccessRemoved when access to the document is revoked on the Sync Gateway. On receiving the event, the application may decide to manually purge the document. However, for performance reasons, any DocumentReplicationListeners added AddDocumentReplicationListener(EventHandler<DocumentReplicationEventArgs>) to the replicator after the replicator is started will not receive the access removed events until the replicator is restarted or reconnected with Sync Gateway.
  • auto-purge will not be performed when DocumentIDs filter is used. Default value is DefaultReplicatorEnableAutoPurge
Declaration
public bool EnableAutoPurge { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Headers

Extra HTTP headers to send in all requests to the remote target

Declaration
public IImmutableDictionary<string, string> Headers { get; set; }
Property Value
Type Description
System.Collections.Immutable.IImmutableDictionary<System.String, System.String>
| Improve this Doc View Source

Heartbeat

Gets or sets the replicator heartbeat keep-alive interval. Default value is DefaultReplicatorHeartbeat (5 min interval).

Declaration
public TimeSpan? Heartbeat { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>
Exceptions
Type Condition
System.ArgumentException

Throw if set the Heartbeat to less or equal to 0 full seconds.
| Improve this Doc View Source

MaxAttempts

Gets or sets the Max number of retry attempts. The retry attempts will reset after the replicator is connected to a remote peer.

Declaration
public int MaxAttempts { get; set; }
Property Value
Type Description
System.Int32
Exceptions
Type Condition
System.ArgumentException

Throw if set the MaxAttempts to a negative value.
| Improve this Doc View Source

MaxAttemptsWaitTime

Gets or sets the Max delay between retries. The default is null (5 min interval is applied).

  • 5 min interval is applied when MaxAttemptsWaitTime is set to null.
  • null will be returned when default 5 min interval is applied. Default value is DefaultReplicatorMaxAttemptsWaitTime
Declaration
public TimeSpan? MaxAttemptsWaitTime { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>
Exceptions
Type Condition
System.ArgumentException

Throw if set the MaxRetryWaitTime to less than 0 full seconds.
| Improve this Doc View Source

PinnedServerCertificate

Gets or sets a certificate to trust. All other certificates received by a Replicator with this configuration will be rejected.

Declaration
public X509Certificate2 PinnedServerCertificate { get; set; }
Property Value
Type Description
System.Security.Cryptography.X509Certificates.X509Certificate2
Remarks

A server will be authenticated if it presents a chain of certificates (possibly of length 1) in which any one of the certificates matches the one passed here.

| Improve this Doc View Source

ProxyAuthenticator

Gets or sets the class which will authenticate with the proxy, if needed.

Declaration
public ProxyAuthenticator ProxyAuthenticator { get; set; }
Property Value
Type Description
ProxyAuthenticator
| Improve this Doc View Source

ReplicatorType

A value indicating the direction of the replication. The default is PushAndPull which is bidirectional Default value is DefaultReplicatorType

Declaration
public ReplicatorType ReplicatorType { get; set; }
Property Value
Type Description
ReplicatorType

Implements

System.IEquatable<T>