copier

Documentation

Overview

Package copier provides a utility type for simplex proxy connections.

Index

• type Copier
  • func (c *Copier) Copy(ctx context.Context) error
  • func (c *Copier) MarshalYAML() (interface{}, error)
  • func (c *Copier) String() string
• type DeadlineReader
• type DeadlineWriter

Types

type Copier

type Copier struct {
	// Activity will be called if it is non-nil whenever traffic
	// has been copied.
	Activity func(written int64)
	From     DeadlineReader
	To       DeadlineWriter
	// The period of time to wait before interrupting a copy to check
	// for Context cancellation or to report the number of bytes copied.
	WakePeriod time.Duration
}

Copier implements a simplex proxy connection.

func (*Copier) Copy

func (c *Copier) Copy(ctx context.Context) error

Copy executes the given copy operation, but adds an occasional check for context cancellation.

func (*Copier) MarshalYAML

func (c *Copier) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler and provides diagnostic information.

func (*Copier) String

func (c *Copier) String() string

type DeadlineReader

type DeadlineReader interface {
	io.Reader
	SetReadDeadline(time.Time) error
}

DeadlineReader is under pressure to perform.

type DeadlineWriter

type DeadlineWriter interface {
	io.Writer
	SetWriteDeadline(time.Time) error
}

DeadlineWriter is under pressure to perform.