# Packages

No description provided by the author

# Functions

DefaultArangoSyncHTTPClient creates a new HTTP client configured for accessing arangosync servers.
GetQueryValue returns value from request query for a given parameter.
IsBadRequest returns true if the given error is caused by a BadRequestError.
IsCanceled returns true if the given error is caused by a context.Canceled.
IsInternalServer returns true if the given error is caused by a InternalServerError.
IsNotFound returns true if the given error is caused by a NotFoundError.
IsPreconditionFailed returns true if the given error is caused by a PreconditionFailedError.
IsRedirectTo returns true when the given error is caused by an RedirectToError.
IsRequestTimeout returns true if the given error is caused by a RequestTimeoutError.
IsServiceUnavailable returns true if the given error is caused by a ServiceUnavailableError.
IsSignificantDelayDiff returns true if there is a significant difference between the given delays.
IsStatusError returns the status code and true if the given error is caused by a StatusError.
IsStatusErrorWithCode returns true if the given error is caused by a StatusError with given code.
IsUnauthorized returns true if the given error is caused by a UnauthorizedError.
NewArangoSyncClient creates a new client implementation.
NewArangoSyncHTTPTransport returns arangosync HTTP transport.
NewAuthentication creates a new Authentication from given arguments.
NewExternalEndpoints creates a new list of endpoints to the external DC's arangosync server (master, worker).
NewHTTPTransport returns default HTTP1 transport.
NewInternalEndpoints creates a new list of endpoints to the internal DC's arangosync server (master, worker).
NewStatusError returns new status error which is serialized in the response to the client.
NormalizeEndpoint cuts off everything what is after the host:port.
ParseEndpoint returns parsed URL if hostname is set.
ParseResponseError returns an error from given response.

# Constants

AllowForwardRequestHeaderKey is a request header key.
ClientIDHeaderKey is the name of a request header containing the ID that is making the request.
GetSyncStatusDetailsFull will return fully populated SyncInfo.
GetSyncStatusDetailsShort does not return Shards info - only total count.
No description provided by the author
No description provided by the author
SyncStatusCancelling indicates that the synchronization process is being cancelled.
SyncStatusFailed indicates that the synchronization process has encountered an unrecoverable failure.
SyncStatusInactive indicates that no synchronization is taking place.
SyncStatusInitializing indicates that synchronization tasks are being setup.
SyncStatusInitialSync indicates that initial synchronization of collections is ongoing.
SyncStatusRunning indicates that all collections have been initially synchronized and normal transaction synchronization is active.

# Variables

BadRequestError indicates invalid arguments.
No description provided by the author
InternalServerError indicates an unspecified error inside the server, perhaps a bug.
NotFoundError indicates that an object does not exist.
PreconditionFailedError indicates that the state of the system is such that the request cannot be executed.
RequestTimeoutError indicates that the request is taken longer than we're prepared to wait.
ServiceUnavailableError indicates that right now the service is not available, please retry later.
UnauthorizedError indicates that the request has not the correct authorization.
ValidSyncStatusValues is a list of all possible sync status values.

# Structs

Authentication contains all possible authentication methods for a client.
No description provided by the author
AuthProxy is a helper that implements github.com/arangodb-helper/go-certificates#TLSAuthentication.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ChecksumSynchronizationRequestOptions describes how checksums should be fetched.
ChecksumSynchronizationResponse describes checksums for all databases.
No description provided by the author
CollectionsChecksum describes checksums for collections within one database.
CommitDirectMQMessageRequest is the JSON request body for CommitDirectMQMessage request.
ConfigurationRequest is the JSON request body for changing configuration.
ConfigureWorkerRequest is the JSON body for the ConfigureWorker request.
DataCenterCollectionResponse stores information about a collection in the data center.
DataCenterDatabaseResponse stores information about a database in the data center.
DataCenterResponse stores information about databases in the data center.
DataCenterShardResponse stores information about a shard in the data center.
DataCentersResponse stores information about databases in many data centers.
DirectMQMessage is a direct MQ message.
DirectMQToken provides a token with its TTL.
DirectMQTokenRequest is the JSON request body for Renew/Clone direct MQ token request.
DirectMQTopicEndpoint provides information about an endpoint for Direct MQ messages.
No description provided by the author
No description provided by the author
ExternalEndpoints describes endpoints to the external datacenter.
GetDirectMQMessagesResponse is the JSON body for GetDirectMQMessages response.
InternalEndpoints describes endpoints to the internal datacenter.
IsChannelRelevantResponse is the JSON response for a MasterAPI.IsChannelRelevant call.
MasterInfo contains information about a single master.
No description provided by the author
MessageQueueConfig contains all deployment configuration info for the local MQ.
MessageQueueConfigExt contains extended MQ config.
MessageTimeoutInfo holds the timeout message info.
No description provided by the author
OutgoingSynchronizationRequest holds the master->master request data for configuring an outgoing inventory stream.
OutgoingSynchronizationResponse holds the answer to an master->master request for configuring an outgoing synchronization.
OutgoingSynchronizeShardRequest holds the master->master request data for configuring an outgoing shard synchronization stream.
OutgoingSyncInfo holds JSON info returned as part of `GET /_api/sync` regarding a specific target for outgoing synchronization data.
No description provided by the author
No description provided by the author
SetDirectMQTopicTokenRequest is the JSON request body for SetDirectMQTopicToken request.
ShardChecksum contains a checksum for the shard.
ShardsChecksum describes checksums for shards within one collection.
ShardSyncInfo holds JSON info returned as part of `GET /_api/sync` regarding a specific shard.
No description provided by the author
No description provided by the author
SynchronizationBarrierStatus contains the status of the active synchronization barrier.
No description provided by the author
SynchronizationShardStatusRequest is the request body of a (Outgoing)SynchronizationStatus request.
SynchronizationShardStatusRequestEntry is a single entry in a SynchronizationShardStatusRequest.
No description provided by the author
SyncInfo holds the JSON info returned from `GET /_api/sync`.
TaskAssignment contains information of the assignment of a task to a worker.
TaskCompletedRequest holds the info for a TaskCompleted request.
TaskInfo contains all information known about a task.
TasksResponse is the JSON response for MasterAPI.Tasks method.
TLSConfig contains the required parameters to build tls.Config.
UpdateIncomingSynchronizationStatusRequest is the request body for UpdateIncomingSynchronizationStatus request.
UpdateMQConfigRequest describes what is required to update a message queue config.
No description provided by the author
WorkerConfiguration contains configuration data passed from the master to the worker.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

API of a sync master/worker.
No description provided by the author
EndpointsCreator describes how endpoints are used for.
InternalDirectMQAPI contains the internal API of the sync master/worker wrt direct MQ messages.
InternalMasterAPI contains the internal API of the sync master.
InternalWorkerAPI contains the internal API of the sync worker.
MasterAPI contains API of sync master.
StatusAPI describes the API provided to task workers used to send status updates to the master.
WorkerAPI contains API of sync worker.

# Type aliases

ConnectionWrapper instructs how to wrap net.Conn connection.
Endpoint is a list of URLs that are considered to be of the same service.
GetSyncStatusDetails specifies what details will be sent in response for sync Status request.
No description provided by the author
No description provided by the author
TLSAuthentication contains configuration for using client certificates and TLS verification of the server.