Documentation
¶
Index ¶
- func Register(name string, handler Handler) error
- func Tail(src io.Reader, n int, dst *[]string)
- type Decoder
- type Engine
- func (eng *Engine) Hack_GetGlobalVar(key string) interface{}
- func (eng *Engine) Hack_SetGlobalVar(key string, val interface{})
- func (eng *Engine) Job(name string, args ...string) *Job
- func (eng *Engine) Logf(format string, args ...interface{}) (n int, err error)
- func (eng *Engine) Register(name string, handler Handler) error
- func (eng *Engine) Root() string
- func (eng *Engine) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (eng *Engine) String() string
- type Env
- func (env *Env) Decode(src io.Reader) error
- func (env *Env) Encode(dst io.Writer) error
- func (env *Env) Exists(key string) bool
- func (env *Env) Export(dst interface{}) (err error)
- func (env *Env) Get(key string) (value string)
- func (env *Env) GetBool(key string) (value bool)
- func (env *Env) GetInt(key string) int
- func (env *Env) GetInt64(key string) int64
- func (env *Env) GetJson(key string, iface interface{}) error
- func (env *Env) GetList(key string) []string
- func (env *Env) Import(src interface{}) (err error)
- func (env *Env) Map() map[string]string
- func (env *Env) Set(key, value string)
- func (env *Env) SetAuto(k string, v interface{})
- func (env *Env) SetBool(key string, value bool)
- func (env *Env) SetInt(key string, value int)
- func (env *Env) SetInt64(key string, value int64)
- func (env *Env) SetJson(key string, value interface{}) error
- func (env *Env) SetList(key string, value []string) error
- func (env *Env) WriteTo(dst io.Writer) (n int64, err error)
- type Hack
- type Handler
- type Input
- type Job
- func (job *Job) CallString() string
- func (job *Job) DecodeEnv(src io.Reader) error
- func (job *Job) EncodeEnv(dst io.Writer) error
- func (job *Job) Environ() map[string]string
- func (job *Job) Error(err error) (int, error)
- func (job *Job) Errorf(format string, args ...interface{}) (n int, err error)
- func (job *Job) ExportEnv(dst interface{}) (err error)
- func (job *Job) Getenv(key string) (value string)
- func (job *Job) GetenvBool(key string) (value bool)
- func (job *Job) GetenvInt(key string) int
- func (job *Job) GetenvInt64(key string) int64
- func (job *Job) GetenvJson(key string, iface interface{}) error
- func (job *Job) GetenvList(key string) []string
- func (job *Job) ImportEnv(src interface{}) (err error)
- func (job *Job) Logf(format string, args ...interface{}) (n int, err error)
- func (job *Job) Printf(format string, args ...interface{}) (n int, err error)
- func (job *Job) Run() error
- func (job *Job) Setenv(key, value string)
- func (job *Job) SetenvBool(key string, value bool)
- func (job *Job) SetenvInt(key string, value int)
- func (job *Job) SetenvInt64(key string, value int64)
- func (job *Job) SetenvJson(key string, value interface{}) error
- func (job *Job) SetenvList(key string, value []string) error
- func (job *Job) StatusString() string
- func (job *Job) String() string
- type Output
- func (o *Output) Add(dst io.Writer) error
- func (o *Output) AddEnv() (dst *Env, err error)
- func (o *Output) AddPipe() (io.Reader, error)
- func (o *Output) AddString(dst *string) error
- func (o *Output) AddTail(dst *[]string, n int) error
- func (o *Output) Close() error
- func (o *Output) Write(p []byte) (n int, err error)
- type Status
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Decoder ¶
func NewDecoder ¶
type Engine ¶
type Engine struct {
Stdout io.Writer
Stderr io.Writer
Stdin io.Reader
// contains filtered or unexported fields
}
The Engine is the core of Docker. It acts as a store for *containers*, and allows manipulation of these containers by executing *jobs*.
func New ¶
New initializes a new engine managing the directory specified at `root`. `root` is used to store containers and any other state private to the engine. Changing the contents of the root without executing a job will cause unspecified behavior.
func (*Engine) Hack_GetGlobalVar ¶
func (*Engine) Hack_SetGlobalVar ¶
func (*Engine) Job ¶
Job creates a new job which can later be executed. This function mimics `Command` from the standard os/exec package.
func (*Engine) ServeHTTP ¶
func (eng *Engine) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP executes a job as specified by the http request `r`, and sends the result as an http response. This method allows an Engine instance to be passed as a standard http.Handler interface.
Note that the protocol used in this methid is a convenience wrapper and is not the canonical implementation of remote job execution. This is because HTTP/1 does not handle stream multiplexing, and so cannot differentiate stdout from stderr. Additionally, headers cannot be added to a response once data has been written to the body, which makes it inconvenient to return metadata such as the exit status.
type Env ¶
type Env []string
type Input ¶
func NewInput ¶
func NewInput() *Input
NewInput returns a new Input object with no source attached. Reading to an empty Input will return io.EOF.
type Job ¶
type Job struct {
Eng *Engine
Name string
Args []string
Stdout *Output
Stderr *Output
Stdin *Input
// contains filtered or unexported fields
}
A job is the fundamental unit of work in the docker engine. Everything docker can do should eventually be exposed as a job. For example: execute a process in a container, create a new container, download an archive from the internet, serve the http api, etc.
The job API is designed after unix processes: a job has a name, arguments, environment variables, standard streams for input, output and error, and an exit status which can indicate success (0) or error (anything else).
One slight variation is that jobs report their status as a string. The string "0" indicates success, and any other strings indicates an error. This allows for richer error reporting.
func (*Job) CallString ¶
func (*Job) DecodeEnv ¶
DecodeEnv decodes `src` as a json dictionary, and adds each decoded key-value pair to the environment.
If `src` cannot be decoded as a json dictionary, an error is returned.
func (*Job) GetenvBool ¶
func (*Job) GetenvInt64 ¶
func (*Job) GetenvJson ¶
func (*Job) GetenvList ¶
Returns nil if key not found
func (*Job) Run ¶
Run executes the job and blocks until the job completes. If the job returns a failure status, an error is returned which includes the status.
func (*Job) SetenvBool ¶
func (*Job) SetenvInt64 ¶
func (*Job) SetenvJson ¶
func (*Job) StatusString ¶
type Output ¶
func NewOutput ¶
func NewOutput() *Output
NewOutput returns a new Output object with no destinations attached. Writing to an empty Output will cause the written data to be discarded.
func (*Output) Add ¶
Add attaches a new destination to the Output. Any data subsequently written to the output will be written to the new destination in addition to all the others. This method is thread-safe. FIXME: Add cannot fail
func (*Output) AddEnv ¶
AddEnv starts a new goroutine which will decode all subsequent data as a stream of json-encoded objects, and point `dst` to the last decoded object. The result `env` can be queried using the type-neutral Env interface. It is not safe to query `env` until the Output is closed.
func (*Output) AddPipe ¶
AddPipe creates an in-memory pipe with io.Pipe(), adds its writing end as a destination, and returns its reading end for consumption by the caller. This is a rough equivalent similar to Cmd.StdoutPipe() in the standard os/exec package. This method is thread-safe.
func (*Output) AddString ¶
AddString starts a new goroutine which will read all subsequent data written to the output, line by line, and store the last line into `dst`.
func (*Output) AddTail ¶
AddTail starts a new goroutine which will read all subsequent data written to the output, line by line, and append the last `n` lines to `dst`.
Source Files