transport

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2023 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package transport provides interfaces for forwarding connections.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config interface {
	// New returns new instance of Transport object.
	New() (Interface, error)

	// Validate should validate Transport configuration.
	Validate() error
}

Config describes how Transport interface should be created.

type Connected added in v0.2.0

type Connected interface {
	// ForwardUnixSocket forwards unix socket to local machine to make it available for the process.
	ForwardUnixSocket(remotePath string) (localPath string, err error)

	// ForwardTCP listens on random local port and forwards incoming connections to given remote address.
	ForwardTCP(remoteAddr string) (localAddr string, err error)
}

Connected interface describes universal way of communicating with remote hosts using different transport protocols.

type Interface added in v0.2.0

type Interface interface {
	// Connect initializes the connection with transport method. For example, if transport method
	// requires initial authentication, it should happen at this point, so further forward errors
	// are more specific.
	Connect() (Connected, error)
}

Interface Transport should be a valid object, which is ready to open connection.

Directories

Path Synopsis
Package direct is a transport.Interface implementation, which simply forwards given addresses "as is", without any modifications.
Package direct is a transport.Interface implementation, which simply forwards given addresses "as is", without any modifications.
Package ssh is a transport.Interface implementation, which forwards given addresses over specified SSH host.
Package ssh is a transport.Interface implementation, which forwards given addresses over specified SSH host.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL