rcli

Documentation

Index

• Variables
• func ListenAndServe(proto, addr string, service Service) error
• func LocalCall(service Service, stdin io.ReadCloser, stdout DockerConn, args ...string) error
• func RestoreTerminal(state *term.State)
• func Serve(conn DockerConn, service Service) error
• func SetRawTerminal() (*term.State, error)
• func Subcmd(output io.Writer, name, signature, description string) *flag.FlagSet
• type Cmd
• type CmdMethod
• type DockerConn
  • func Call(proto, addr string, args ...string) (DockerConn, error)
• type DockerConnOptions
• type DockerLocalConn
  • func NewDockerLocalConn(w io.WriteCloser) *DockerLocalConn
  • func (c *DockerLocalConn) Close() error
  • func (c *DockerLocalConn) CloseRead() error
  • func (c *DockerLocalConn) CloseWrite() error
  • func (c *DockerLocalConn) Flush() error
  • func (c *DockerLocalConn) GetOptions() *DockerConnOptions
  • func (c *DockerLocalConn) Read(b []byte) (int, error)
  • func (c *DockerLocalConn) SetOptionRawTerminal()
  • func (c *DockerLocalConn) Write(b []byte) (int, error)
• type DockerTCPConn
  • func NewDockerTCPConn(conn *net.TCPConn, client bool) *DockerTCPConn
  • func (c *DockerTCPConn) Close() error
  • func (c *DockerTCPConn) CloseRead() error
  • func (c *DockerTCPConn) CloseWrite() error
  • func (c *DockerTCPConn) Flush() error
  • func (c *DockerTCPConn) GetOptions() *DockerConnOptions
  • func (c *DockerTCPConn) Read(b []byte) (int, error)
  • func (c *DockerTCPConn) SetOptionRawTerminal()
  • func (c *DockerTCPConn) Write(b []byte) (int, error)
• type Service

Variables

var CLIENT_SOCKET io.Writer = nil

var DEBUG_FLAG bool = false

Note: the globals are here to avoid import cycle FIXME: Handle debug levels mode?

var UnknownDockerProto = fmt.Errorf("Only TCP is actually supported by Docker at the moment")

Functions

func ListenAndServe

func ListenAndServe(proto, addr string, service Service) error

Listen on `addr`, using protocol `proto`, for incoming rcli calls, and pass them to `service`.

func LocalCall

func LocalCall(service Service, stdin io.ReadCloser, stdout DockerConn, args ...string) error

func RestoreTerminal

func RestoreTerminal(state *term.State)

func Serve

func Serve(conn DockerConn, service Service) error

Parse an rcli call on a new connection, and pass it to `service` if it is valid.

func SetRawTerminal

func SetRawTerminal() (*term.State, error)

FIXME: move these function to utils.go (in rcli to avoid import loop)

func Subcmd

func Subcmd(output io.Writer, name, signature, description string) *flag.FlagSet

Types

type Cmd

type Cmd func(io.ReadCloser, io.Writer, ...string) error

type CmdMethod

type CmdMethod func(Service, io.ReadCloser, io.Writer, ...string) error

type DockerConn

type DockerConn interface {
	io.ReadWriteCloser
	CloseWrite() error
	CloseRead() error
	GetOptions() *DockerConnOptions
	SetOptionRawTerminal()
	Flush() error
}

func Call

func Call(proto, addr string, args ...string) (DockerConn, error)

Connect to a remote endpoint using protocol `proto` and address `addr`, issue a single call, and return the result. `proto` may be "tcp", "unix", etc. See the `net` package for available protocols.

type DockerConnOptions

type DockerConnOptions struct {
	RawTerminal bool
}

type DockerLocalConn

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

func NewDockerLocalConn

func NewDockerLocalConn(w io.WriteCloser) *DockerLocalConn

func (*DockerLocalConn) Close

func (c *DockerLocalConn) Close() error

func (*DockerLocalConn) CloseRead

func (c *DockerLocalConn) CloseRead() error

func (*DockerLocalConn) CloseWrite

func (c *DockerLocalConn) CloseWrite() error

func (*DockerLocalConn) Flush

func (c *DockerLocalConn) Flush() error

func (*DockerLocalConn) GetOptions

func (c *DockerLocalConn) GetOptions() *DockerConnOptions

func (*DockerLocalConn) Read

func (c *DockerLocalConn) Read(b []byte) (int, error)

func (*DockerLocalConn) SetOptionRawTerminal

func (c *DockerLocalConn) SetOptionRawTerminal()

func (*DockerLocalConn) Write

func (c *DockerLocalConn) Write(b []byte) (int, error)

type DockerTCPConn

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

func NewDockerTCPConn

func NewDockerTCPConn(conn *net.TCPConn, client bool) *DockerTCPConn

func (*DockerTCPConn) Close

func (c *DockerTCPConn) Close() error

func (*DockerTCPConn) CloseRead

func (c *DockerTCPConn) CloseRead() error

func (*DockerTCPConn) CloseWrite

func (c *DockerTCPConn) CloseWrite() error

func (*DockerTCPConn) Flush

func (c *DockerTCPConn) Flush() error

func (*DockerTCPConn) GetOptions

func (c *DockerTCPConn) GetOptions() *DockerConnOptions

func (*DockerTCPConn) Read

func (c *DockerTCPConn) Read(b []byte) (int, error)

func (*DockerTCPConn) SetOptionRawTerminal

func (c *DockerTCPConn) SetOptionRawTerminal()

func (*DockerTCPConn) Write

func (c *DockerTCPConn) Write(b []byte) (int, error)

type Service

type Service interface {
	Name() string
	Help() string
}