github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

plugin: Fix runtime interface documentation

Browse Source 
Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
This commit is contained in:
Samuel Ortiz 2017-06-19 18:33:52 +02:00
parent 7e3b7dead6
commit ddea395572
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
plugin/runtime.go
View File

@ -34,14 +34,15 @@ type Exit struct {
type Runtime interface { type Runtime interface {
// ID of the runtime // ID of the runtime
ID() string ID() string
// Create creates a container with the provided id and options // Create creates a task with the provided id and options.
Create(ctx context.Context, id string, opts CreateOpts) (Task, error) Create(ctx context.Context, id string, opts CreateOpts) (Task, error)
// Get returns a container // Get returns a task.
Get(context.Context, string) (Task, error) Get(context.Context, string) (Task, error)
// Containers returns all the current containers for the runtime // Tasks returns all the current tasks for the runtime.
// Any container runs at most one task at a time.
Tasks(context.Context) ([]Task, error) Tasks(context.Context) ([]Task, error)
// Delete removes the container in the runtime // Delete removes the task in the runtime.
Delete(context.Context, Task) (*Exit, error) Delete(context.Context, Task) (*Exit, error)
// Events returns events for the runtime and all containers created by the runtime // Events returns events for the runtime and all tasks created by the runtime
Events(context.Context) <-chan *Event Events(context.Context) <-chan *Event
} }