connection

Documentation

Index

• Variables
• type Connection
  • func New(network, address string) Connection
  • func NewWithDialerAndLogger(dialer DialerFunc, log lager.Logger) Connection
  • func NewWithHijacker(hijacker HijackStreamer, log lager.Logger) Connection
  • func NewWithLogger(network, address string, logger lager.Logger) Connection
• type DialerFunc
• type Error
  • func (err Error) Error() string
• type HijackStreamer
  • func NewHijackStreamer(network, address string) HijackStreamer
  • func NewHijackStreamerWithDialer(dialFunc DialerFunc) HijackStreamer

Variables

var ErrDisconnected = errors.New("disconnected")

var ErrInvalidMessage = errors.New("invalid message payload")

Types

type Connection

type Connection interface {
	Ping() error

	Capacity() (garden.Capacity, error)

	Create(spec garden.ContainerSpec) (string, error)
	List(properties garden.Properties) ([]string, error)

	// Destroys the container with the given handle. If the container cannot be
	// found, garden.ContainerNotFoundError is returned. If deletion fails for another
	// reason, another error type is returned.
	Destroy(handle string) error

	Stop(handle string, kill bool) error

	Info(handle string) (garden.ContainerInfo, error)
	BulkInfo(handles []string) (map[string]garden.ContainerInfoEntry, error)
	BulkMetrics(handles []string) (map[string]garden.ContainerMetricsEntry, error)

	StreamIn(handle string, spec garden.StreamInSpec) error
	StreamOut(handle string, spec garden.StreamOutSpec) (io.ReadCloser, error)

	CurrentBandwidthLimits(handle string) (garden.BandwidthLimits, error)
	CurrentCPULimits(handle string) (garden.CPULimits, error)
	CurrentDiskLimits(handle string) (garden.DiskLimits, error)
	CurrentMemoryLimits(handle string) (garden.MemoryLimits, error)

	Run(handle string, spec garden.ProcessSpec, io garden.ProcessIO) (garden.Process, error)
	Attach(handle string, processID string, io garden.ProcessIO) (garden.Process, error)

	NetIn(handle string, hostPort, containerPort uint32) (uint32, uint32, error)
	NetOut(handle string, rule garden.NetOutRule) error

	SetGraceTime(handle string, graceTime time.Duration) error

	Properties(handle string) (garden.Properties, error)
	Property(handle string, name string) (string, error)
	SetProperty(handle string, name string, value string) error

	Metrics(handle string) (garden.Metrics, error)
	RemoveProperty(handle string, name string) error
}

func New

func New(network, address string) Connection

func NewWithDialerAndLogger

func NewWithDialerAndLogger(dialer DialerFunc, log lager.Logger) Connection

func NewWithHijacker

func NewWithHijacker(hijacker HijackStreamer, log lager.Logger) Connection

func NewWithLogger

func NewWithLogger(network, address string, logger lager.Logger) Connection

type DialerFunc

type DialerFunc func(network, address string) (net.Conn, error)

type Error

type Error struct {
	StatusCode int
	Message    string
}

func (Error) Error

func (err Error) Error() string

type HijackStreamer

type HijackStreamer interface {
	Stream(handler string, body io.Reader, params rata.Params, query url.Values, contentType string) (io.ReadCloser, error)
	Hijack(handler string, body io.Reader, params rata.Params, query url.Values, contentType string) (net.Conn, *bufio.Reader, error)
}

func NewHijackStreamer

func NewHijackStreamer(network, address string) HijackStreamer

func NewHijackStreamerWithDialer

func NewHijackStreamerWithDialer(dialFunc DialerFunc) HijackStreamer