host

Documentation

Overview

Package host collects all transport interface implementations and provides an unified configuration interface for these.

Index

• type Host
  • func BuildConfig(config, defaults Host) Host
  • func (h *Host) New() (transport.Interface, error)
  • func (h *Host) Validate() error

Types

type Host

type Host struct {
	// DirectConfig indicates, that no forwarding should occur, so addresses will
	// be returned as given.
	DirectConfig *direct.Config `json:"direct,omitempty"`

	// SSHConfig configures given addresses to be forwarded using SSH tunneling.
	SSHConfig *ssh.Config `json:"ssh,omitempty"`
}

Host allows to forward TCP ports, UNIX sockets to local machine to establish communication with remote daemons.

Exactly one transport method must be configured.

func BuildConfig

func BuildConfig(config, defaults Host) Host

BuildConfig merges values from both host objects. This is a helper method used for building hierarchical configuration.

func (*Host) New

func (h *Host) New() (transport.Interface, error)

New validates Host configuration and sets configured transport method.

func (*Host) Validate

func (h *Host) Validate() error

Validate validates host configuration.