api

README

This directory contains code pertaining to the Docker API:

• Used by the docker client when communicating with the docker daemon

• Used by third party tools wishing to interface with the docker daemon

Documentation

Index

• Constants
• func DisplayablePorts(ports *engine.Table) string
• func FormGroup(key string, start, last int) string
• func LoadOrCreateTrustKey(trustKeyPath string) (libtrust.PrivateKey, error)
• func MatchesContentType(contentType, expectedType string) bool
• func NewDisplayablePorts(ports []types.Port) string
• func ValidateHost(val string) (string, error)
• type ByPrivatePort
  • func (r ByPrivatePort) Len() int
  • func (r ByPrivatePort) Less(i, j int) bool
  • func (r ByPrivatePort) Swap(i, j int)

Constants

const (
	APIVERSION            version.Version = "1.19"                 // Current REST API version
	DEFAULTHTTPHOST                       = "127.0.0.1"            // Default HTTP Host used if only port is provided to -H flag e.g. docker -d -H tcp://:8080
	DEFAULTUNIXSOCKET                     = "/var/run/docker.sock" // Docker daemon by default always listens on the default unix socket
	DefaultDockerfileName string          = "Dockerfile"           // Default filename with Docker commands, read by docker build
)

Common constants for daemon and client.

Functions

func DisplayablePorts

func DisplayablePorts(ports *engine.Table) string

TODO remove, used on < 1.5 in getContainersJSON TODO this can go away when we get rid of engine.table

func FormGroup

func FormGroup(key string, start, last int) string

func LoadOrCreateTrustKey

func LoadOrCreateTrustKey(trustKeyPath string) (libtrust.PrivateKey, error)

LoadOrCreateTrustKey attempts to load the libtrust key at the given path, otherwise generates a new one

func MatchesContentType

func MatchesContentType(contentType, expectedType string) bool

func NewDisplayablePorts

func NewDisplayablePorts(ports []types.Port) string

TODO Rename to DisplayablePorts (remove "New") when engine.Table goes away

func ValidateHost

func ValidateHost(val string) (string, error)

Types

type ByPrivatePort

type ByPrivatePort []types.Port

func (ByPrivatePort) Len

func (r ByPrivatePort) Len() int

func (ByPrivatePort) Less

func (r ByPrivatePort) Less(i, j int) bool

func (ByPrivatePort) Swap

func (r ByPrivatePort) Swap(i, j int)