dockeriface

Documentation

Index

• type Client
• type DockerContainerChangeEvent
• type ListContainersResponse
• type ResponseError

Types

type Client

type Client interface {
	// Version returns the version of the Docker daemon.
	Version(ctx context.Context, timeout time.Duration) (version types.Version, err error)

	// Stop is stopping the client
	Stop() (err error)

	// ListContainers returns the containers known to the daemon
	ListContainers(ctx context.Context, timeout time.Duration, all bool) ListContainersResponse

	// AttachContainerEvents returns a channel to listen to the Docker event stream
	ContainerEvents(ctx context.Context) (<-chan events.Message, <-chan error)
}

Client interface to implement tests

type DockerContainerChangeEvent

type DockerContainerChangeEvent struct {
}

DockerContainerChangeEvent is a type for container change events

type ListContainersResponse

type ListContainersResponse struct {
	// DockerIDs is the list of container IDs from the ListContainers call
	DockerIDs []string
	// Error contains any error returned when listing containers
	Error ResponseError
}

ListContainersResponse encapsulates the response from the docker client for listing containers

type ResponseError

type ResponseError error

ResponseError is containing a response error