docker

Documentation

Index

• type Atom
  • func (c *Atom) CreatedAt() time.Time
  • func (c *Atom) ID() string
  • func (c *Atom) Result() atom.Result
  • func (c *Atom) StartedAt() time.Time
  • func (c *Atom) State() atom.State
  • func (c *Atom) StoppedAt() time.Time
• type Engine
  • func NewEngine(ctx context.Context) Engine

Types

type Atom

type Atom struct {
	atom.Atom
	// contains filtered or unexported fields
}

Atom defines the interface for treating Docker containers as Caesium Atoms.

func (*Atom) CreatedAt

func (c *Atom) CreatedAt() time.Time

CreatedAt returns the UTC time the Atom was created.

func (*Atom) ID

func (c *Atom) ID() string

ID returns the ID of the Atom. This ID is identical to the Docker ID assigned by the Docker daemon.

func (*Atom) Result

func (c *Atom) Result() atom.Result

Result returns the result of the Atom. This function maps Docker container exit codes to Caesium Atom results.

func (*Atom) StartedAt

func (c *Atom) StartedAt() time.Time

StartedAt returns the UTC time the Atom was started.

func (*Atom) State

func (c *Atom) State() atom.State

State returns the state of the Atom. This function maps Docker container states to Caesium Atom states.

func (*Atom) StoppedAt

func (c *Atom) StoppedAt() time.Time

StoppedAt returns the UTC time the Atom was stopped.

type Engine

type Engine interface {
	atom.Engine
}

Engine defines the interface for treating the Docker API as a atom.Engine.

func NewEngine

func NewEngine(ctx context.Context) Engine

NewEngine creates a new instance of docker.Engine for interacting with docker.Atoms.