stdio

Documentation

Index

• func NewConsole() (*os.File, string, error)
• func ResizeConsole(pty *os.File, height, width uint16) error
• type ConnectionSet
  • func (s *ConnectionSet) Close() error
  • func (s *ConnectionSet) Files() (_ *FileSet, err error)
  • func (s *ConnectionSet) NewPipeRelay() (_ *PipeRelay, err error)
  • func (s *ConnectionSet) NewTtyRelay(pty *os.File) *TtyRelay
• type FileSet
  • func (fs *FileSet) Close() error
• type PipeRelay
  • func (pr *PipeRelay) Files() (*FileSet, error)
  • func (pr *PipeRelay) Start()
  • func (pr *PipeRelay) Wait()
• type TtyRelay
  • func (r *TtyRelay) ResizeConsole(height, width uint16) error
  • func (r *TtyRelay) Start()
  • func (r *TtyRelay) Wait()

Functions

func NewConsole

func NewConsole() (*os.File, string, error)

NewConsole allocates a new console and returns the File for its master and path for its slave.

func ResizeConsole

func ResizeConsole(pty *os.File, height, width uint16) error

ResizeConsole sends the appropriate resize to a pTTY FD Synchronization of pty should be handled in the callers context.

Types

type ConnectionSet

type ConnectionSet struct {
	In, Out, Err transport.Connection
}

ConnectionSet is a structure defining the readers and writers the Core implementation should forward a process's stdio through.

func (*ConnectionSet) Close

func (s *ConnectionSet) Close() error

Close closes each stdio connection.

func (*ConnectionSet) Files

func (s *ConnectionSet) Files() (_ *FileSet, err error)

Files returns a FileSet with an os.File for each connection in the connection set.

func (*ConnectionSet) NewPipeRelay

func (s *ConnectionSet) NewPipeRelay() (_ *PipeRelay, err error)

NewPipeRelay returns a new pipe relay wrapping the given connection stdin, stdout, stderr set.

func (*ConnectionSet) NewTtyRelay

func (s *ConnectionSet) NewTtyRelay(pty *os.File) *TtyRelay

NewTtyRelay returns a new TTY relay for a given master PTY file.

type FileSet

type FileSet struct {
	In, Out, Err *os.File
}

FileSet contains os.File fields for stdio.

func (*FileSet) Close

func (fs *FileSet) Close() error

Close closes all the FileSet handles.

type PipeRelay

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

PipeRelay is a relay built to expose a pipe interface for stdin, stdout, stderr on top of a ConnectionSet.

func (*PipeRelay) Files

func (pr *PipeRelay) Files() (*FileSet, error)

Files returns a FileSet with an os.File for each connection in the connection set.

func (*PipeRelay) Start

func (pr *PipeRelay) Start()

Start starts the relay operation. The caller must call Wait to wait for the relay to finish and release the associated resources.

func (*PipeRelay) Wait

func (pr *PipeRelay) Wait()

Wait waits for the relaying to finish and closes the associated pipes and connections.

type TtyRelay

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

TtyRelay relays IO between a set of stdio connections and a master PTY file.

func (*TtyRelay) ResizeConsole

func (r *TtyRelay) ResizeConsole(height, width uint16) error

ResizeConsole sends the appropriate resize to a pTTY FD

func (*TtyRelay) Start

func (r *TtyRelay) Start()

Start starts the relay operation. The caller must call Wait to wait for the relay to finish and release the associated resources.

func (*TtyRelay) Wait

func (r *TtyRelay) Wait()

Wait waits for the relaying to finish and closes the associated files and connections.