transport

Documentation

Overview

Package transport provides interfaces for forwarding connections.

Index

• type Config
• type Connected
• type Interface

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

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

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.