package remote

Get desktop application:
View/edit binary Protocol Buffers messages

EndpointRequest is a sum type that can transmit any type of endpoint request. Only the sent request will be non-nil. We intentionally avoid using Protocol Buffers' oneof feature because it generates really ugly code and an unwieldy API, at least in Go. Manually checking for exclusivity is not difficult.

• optional PollRequest poll = 1

  Poll represents a poll request.

• optional ScanRequest scan = 2

  Scan represents a scan request.

• optional StageRequest stage = 3

  Stage represents a stage request.

• optional SupplyRequest supply = 4

  Supply represents a supply request.

• optional TransitionRequest transition = 5

  Transition represents a transition request.

InitializeForwardingRequest is the initialization request sent to remote forwarding endpoints.

• forwarding.Version version = 2

  Field 1 is reserved for the session identifier. Version is the session version.

• optional forwarding.Configuration configuration = 3

  Configuration is the session configuration.

• string protocol = 4

  Protocol is the protocol specification for the listener/dialer.

• string address = 5

  Address it the bind address for a listener or dial address for a dialer.

• bool listener = 6

  Listener indicates whether this endpoint should function as a listener or dialer for the associated address.

InitializeForwardingResponse is the initialization response sent from remote forwarding endpoint.

• string error = 1

  Error is any error that occurred during initialization.

InitializeSynchronizationRequest encodes a request for endpoint initialization.

• string session = 1

  Session is the session identifier.

• synchronization.Version version = 2

  Version is the session version.

• optional synchronization.Configuration configuration = 3

  Configuration is the session configuration.

• string root = 4

  Root is the synchronization root path.

• bool alpha = 5

  Alpha indicates whether or not the endpoint should behave as alpha (as opposed to beta).

InitializeSynchronizationResponse encodes initialization results.

• string error = 1

  Error is the error message (if any) resulting from initialization.

PollCompletionRequest is paired with PollRequest and indicates a request for early polling completion or an acknowledgement of completion.

(message has no fields)

PollRequest encodes a request for one-shot polling.

Used in: EndpointRequest

(message has no fields)

PollResponse indicates polling completion.

• string error = 1

  Error is the error message (if any) resulting from polling.

ScanCompletionRequest is paired with a ScanRequest and indicates a request for scan cancellation or an acknowledgement of completion.

(message has no fields)

ScanRequest encodes a request for a scan.

Used in: EndpointRequest

• optional rsync.Signature baselineSnapshotSignature = 1

  BaselineSnapshotSignature is the rsync signature to use as the base for differentially transmitting snapshots.

• bool full = 2

  Full indicates whether or not to force a full (warm) scan, temporarily avoiding any acceleration that might be available on the endpoint.

ScanResponse encodes the results of a scan.

• repeated rsync.Operation snapshotDelta = 1

  SnapshotDelta are the operations need to reconstruct the snapshot against the specified base.

• string error = 2

  Error is the error message (if any) resulting from scanning.

• bool tryAgain = 3

  TryAgain indicates whether or not the error is ephermeral.

StageRequest encodes a request for staging.

Used in: EndpointRequest

• repeated string paths = 1

  Paths lists the paths that need to be staged.

• repeated bytes digests = 2

  Digests lists the digests for the paths that need to be staged. Its length and contents correspond to that of Paths.

StageResponse encodes the results of staging initialization.

• repeated string paths = 1

  Paths are the paths that need to be staged after filtering. If its length is zero and the length of Signatures is non-zero, then it's assumed that all paths are required and (in that scenario) the length of Signatures must be equal to the length of the original path list.

• repeated rsync.Signature signatures = 2

  Signatures are the rsync signatures of the paths needing to be staged.

• string error = 3

  Error is the error message (if any) resulting from staging initialization.

SupplyRequest indicates a request for supplying files.

Used in: EndpointRequest

• repeated string paths = 1

  Paths are the paths to provide (relative to the synchronization root).

• repeated rsync.Signature signatures = 2

  Signatures are the rsync signatures of the paths needing to be staged.

TransitionCompletionRequest is paired with a TransitionRequest and indicates a request for transition cancellation or an acknowledgement of completion.

(message has no fields)

TransitionRequest encodes a request for transition application.

Used in: EndpointRequest

• repeated core.Change transitions = 1

  Transitions are the transitions that need to be applied.

TransitionResponse encodes the results of transitioning.

• repeated core.Archive results = 1

  Results are the resulting contents post-transition. HACK: We have to use Archive to wrap our Entry results here because Protocol Buffers won't encode a nil pointer in a repeated element in certain cases, and the results of transitions may very well be nil. gob also exhibits this problem.

• repeated core.Problem problems = 2

  Problems are any problems encountered during the transition operation.

• bool stagerMissingFiles = 3

  StagerMissingFiles indicates whether or not the endpoint's stager indicated missing files during transitioning.

• string error = 4

  Error is the error message (if any) resulting from the remote transition method. This will always be an empty string since transition doesn't return errors from local endpoints, but to match the endpoint interface (which allows for transition errors due to network failures with remote endpoints), we include this field. TODO: Should we just remove this field? Doing so would rely on knowledge of localEndpoint's transition behavior.