package forwarding

Get desktop application:
View/edit binary Protocol Buffers messages

Forwarding manages the lifecycle of forwarding sessions.

• rpc Create (CreateRequest, CreateResponse)

  forwarding.proto:105

  Create creates a new session.

  message CreateRequest

  forwarding.proto:39

  CreateRequest encodes a request for session creation.

  • string prompter = 1

    Prompter is the prompter identifier to use for creating sessions.

  • optional CreationSpecification specification = 2

    Specification is the creation specification.

  message CreateResponse

  forwarding.proto:47

  CreateResponse encodes a session creation response.

  • string session = 1

    Session is the resulting session identifier.

• rpc List (ListRequest, ListResponse)

  forwarding.proto:107

  List returns metadata for existing sessions.

  message ListRequest

  forwarding.proto:53

  ListRequest encodes a request for session metadata.

  • optional selection.Selection selection = 1

    Selection is the session selection criteria.

  • uint64 previousStateIndex = 2

    PreviousStateIndex is the previously seen state index. 0 may be provided to force an immediate state listing.

  message ListResponse

  forwarding.proto:62

  ListResponse encodes session metadata.

  • uint64 stateIndex = 1

    StateIndex is the state index associated with the session metadata.

  • repeated State sessionStates = 2

    SessionStates are the session metadata states.

• rpc Pause (PauseRequest, PauseResponse)

  forwarding.proto:109

  Pause pauses sessions.

  message PauseRequest

  forwarding.proto:70

  PauseRequest encodes a request to pause sessions.

  • string prompter = 1

    Prompter is the prompter to use for status message updates.

  • optional selection.Selection selection = 2

    Selection is the session selection criteria.

  message PauseResponse

  forwarding.proto:78

  PauseResponse indicates completion of pause operation(s).

  (message has no fields)

• rpc Resume (ResumeRequest, ResumeResponse)

  forwarding.proto:111

  Resume resumes paused or disconnected sessions.

  message ResumeRequest

  forwarding.proto:81

  ResumeRequest encodes a request to resume sessions.

  • string prompter = 1

    Prompter is the prompter identifier to use for resuming sessions.

  • optional selection.Selection selection = 2

    Selection is the session selection criteria.

  message ResumeResponse

  forwarding.proto:89

  ResumeResponse indicates completion of resume operation(s).

  (message has no fields)

• rpc Terminate (TerminateRequest, TerminateResponse)

  forwarding.proto:113

  Terminate terminates sessions.

  message TerminateRequest

  forwarding.proto:92

  TerminateRequest encodes a request to terminate sessions.

  • string prompter = 1

    Prompter is the prompter to use for status message updates.

  • optional selection.Selection selection = 2

    Selection is the session selection criteria.

  message TerminateResponse

  forwarding.proto:100

  TerminateResponse indicates completion of termination operation(s).

  (message has no fields)

Configuration encodes session configuration parameters. It is used for create commands to specify configuration options, for loading global configuration options, and for storing a merged configuration inside sessions. It should be considered immutable.

Fields 1-20 are reserved for core forwarding configuration parameters.

Used in: CreationSpecification, Session, remote.InitializeForwardingRequest

• SocketOverwriteMode socketOverwriteMode = 41

  SocketOverwriteMode specifies whether or not existing Unix domain sockets should be overwritten when creating new listener sockets.

• string socketOwner = 42

  SocketOwner specifies the owner identifier to use for Unix domain listener sockets.

• string socketGroup = 43

  SocketGroup specifies the group identifier to use for Unix domain listener sockets.

• uint32 socketPermissionMode = 44

  SocketPermissionMode specifies the permission mode to use for Unix domain listener sockets.

CreationSpecification contains the metadata required for a new session.

Used in: CreateRequest

• optional url.URL source = 1

  Source is the source endpoint URL for the session.

• optional url.URL destination = 2

  Destination is the destination endpoint URL for the session.

• optional Configuration configuration = 3

  Configuration is the base session configuration. It is the result of merging the global configuration (unless disabled), any manually specified configuration file, and any command line configuration parameters.

• optional Configuration configurationSource = 4

  ConfigurationSource is the source-specific session configuration. It is determined based on command line configuration parameters.

• optional Configuration configurationDestination = 5

  ConfigurationDestination is the destination-specific session configuration. It is determined based on command line configuration parameters.

• string name = 6

  Name is the name for the session object.

• map<string, string> labels = 7

  Labels are the labels for the session object.

• bool paused = 8

  Paused indicates whether or not to create the session pre-paused.

EndpointState encodes the current state of a forwarding endpoint. It is mutable within the context of the daemon, so it should be accessed and modified in a synchronized fashion. Outside of the daemon (e.g. when returned via the API), it should be considered immutable.

Used in: State

• bool connected = 1

  Connected indicates whether or not the controller is currently connected to the endpoint.

Session represents a forwarding session configuration and persistent state. It is mutable within the context of the daemon, so it should be accessed and modified in a synchronized fashion. Outside of the daemon (e.g. when returned via the API), it should be considered immutable.

The identifier, version, creationTime, and creatingVersion* fields are considered the "header" fields for all session versions. A message composed purely of these fields is guaranteed to be compatible with all future session versions. This can be used to dispatch session decoding to more specific message structures once multiple session version formats are implemented.

Used in: State

• string identifier = 1

  Identifier is the (unique) session identifier. It is static. It cannot be empty.

• Version version = 2

  Version is the session version. It is static.

• optional google.protobuf.Timestamp creationTime = 3

  CreationTime is the creation time of the session. It is static. It cannot be nil.

• uint32 creatingVersionMajor = 4

  CreatingVersionMajor is the major version component of the version of Mutagen which created the session. It is static.

• uint32 creatingVersionMinor = 5

  CreatingVersionMinor is the minor version component of the version of Mutagen which created the session. It is static.

• uint32 creatingVersionPatch = 6

  CreatingVersionPatch is the patch version component of the version of Mutagen which created the session. It is static.

• optional url.URL source = 7

  Source is the source endpoint URL. It is static. It cannot be nil.

• optional url.URL destination = 8

  Destination is the destination endpoint URL. It is static. It cannot be nil.

• optional Configuration configuration = 9

  Configuration is the flattened session configuration. It is static. It cannot be nil.

• optional Configuration configurationSource = 10

  ConfigurationSource are the source-specific session configuration overrides. It is static.

• optional Configuration configurationDestination = 11

  ConfigurationDestination are the destination-specific session configuration overrides. It is static.

• string name = 12

  Name is a user-friendly name for the session. It may be empty and is not guaranteed to be unique across all sessions. It is only used as a simpler handle for specifying sessions. It is static.

• map<string, string> labels = 13

  Labels are the session labels. They are static.

• bool paused = 14

  Paused indicates whether or not the session is marked as paused.

SocketOverwriteMode specifies the behavior for overwriting (removing) existing Unix domain sockets.

Used in: Configuration

• SocketOverwriteModeDefault = 0

  SocketOverwriteMode_SocketOverwriteModeDefault represents an unspecified socket overwrite mode. It should be converted to one of the following values based on the desired default behavior.

• SocketOverwriteModeLeave = 1

  SocketOverwriteMode_SocketOverwriteModeLeave specifies that existing sockets should not be overwritten when creating a Unix domain socket listener.

• SocketOverwriteModeOverwrite = 2

  SocketOverwriteMode_SocketOverwriteModeOverwrite specifies that existing sockets should be overwritten when creating a Unix domain socket listener.

State encodes the current state of a forwarding session. It is mutable within the context of the daemon, so it should be accessed and modified in a synchronized fashion. Outside of the daemon (e.g. when returned via the API), it should be considered immutable.

Used in: ListResponse

• optional Session session = 1

  Session is the session specification.

• Status status = 2

  Status is the status of the session.

• string lastError = 3

  LastError indicates the last error that occurred during forwarding.

• uint64 openConnections = 4

  OpenConnections is the number of connections currently open and being forwarded.

• uint64 totalConnections = 5

  TotalConnections is the number of total connections that have been opened and forwarded (including those that are currently open).

• uint64 totalOutboundData = 6

  TotalOutboundData is the total amount of data (in bytes) that has been transmitted from source to destination across all forwarded connections.

• uint64 totalInboundData = 7

  TotalInboundData is the total amount of data (in bytes) that has been transmitted from destination to source across all forwarded connections.

• optional EndpointState sourceState = 8

  SourceState encodes the state of the source endpoint. It is always non-nil.

• optional EndpointState destinationState = 9

  DestinationState encodes the state of the destination endpoint. It is always non-nil.

Status encodes the status of a forwarding session.

Used in: State

• Disconnected = 0

  Status_Disconnected indicates that the session is disconnected.

• ConnectingSource = 1

  Status_ConnectingSource indicates that the session is in the process of connecting to the source endpoint.

• ConnectingDestination = 2

  Status_ConnectingDestination indicates that the session is in the process of connecting to the destination endpoint.

• ForwardingConnections = 3

  Status_ForwardingConnections indicates that the session is connected and currently forwarding connections.

Version specifies a session version, providing default behavior that can vary without affecting existing sessions.

Used in: Session, remote.InitializeForwardingRequest

• Invalid = 0

  Invalid is the default session version and represents an unspecfied and invalid version. It is used as a sanity check to ensure that version is set for a session.

• Version1 = 1

  Version1 represents session version 1.