catp

Documentation

Index

• func Start(command []string, streamIn io.Reader, streamOut io.Writer, ...) error
• type Chain
  • func New() Chain
  • func (c *Chain) Add(pipe Pipe)
  • func (c *Chain) Run(input io.Reader, output io.Writer) (result error)
• type Pipe
• type ProcessConfiguration
• type ProcessPipe
  • func NewProcessPipe(configuration ProcessConfiguration) *ProcessPipe
  • func (p *ProcessPipe) Start()
• type SimplePipe
  • func (p *SimplePipe) Configure(input io.Reader, output io.Writer, doneHandler func(), ...) io.Reader
  • func (p *SimplePipe) Start()

Functions

func Start

func Start(command []string, streamIn io.Reader, streamOut io.Writer, captureStderr io.Writer) error

Start create a catp chain and start it.

Types

type Chain

type Chain struct {
	// contains filtered or unexported fields
}

func New

func New() Chain

New build a new catp chain.

func (*Chain) Add

func (c *Chain) Add(pipe Pipe)

func (*Chain) Run

func (c *Chain) Run(input io.Reader, output io.Writer) (result error)

type Pipe

type Pipe interface {
	Configure(input io.Reader, output io.Writer, doneHandler func(), errorHandler func(error)) io.Reader
	Start()
}

Pipe stream data from input to output.

type ProcessConfiguration

type ProcessConfiguration struct {
	Command []string
	Stderr  io.Writer
}

ProcessConfiguration is the process execute by catp.

type ProcessPipe

type ProcessPipe struct {
	SimplePipe
	ProcessConfiguration
}

func NewProcessPipe

func NewProcessPipe(configuration ProcessConfiguration) *ProcessPipe

func (*ProcessPipe) Start

func (p *ProcessPipe) Start()

type SimplePipe

type SimplePipe struct {
	// contains filtered or unexported fields
}

func (*SimplePipe) Configure

func (p *SimplePipe) Configure(
	input io.Reader, output io.Writer,
	doneHandler func(),
	errorHandler func(error)) io.Reader

func (*SimplePipe) Start

func (p *SimplePipe) Start()

Start a goroutine to copy data from input to output.