Add docs around multiple attach

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
This commit is contained in:
Michael Crosby
2017-10-06 16:39:38 -04:00
parent 987fcd1201
commit bbb01ee1ab
2 changed files with 7 additions and 0 deletions

View File

@@ -32,6 +32,9 @@ type Container interface {
//
// If IOAttach options are passed the client will reattach to the IO for the running
// task. If no task exists for the container a NotFound error is returned
//
// Clients must make sure that only one reader is attached to the task and consuming
// the output from the task's fifos
Task(context.Context, IOAttach) (Task, error)
// Image returns the image that the container is based on
Image(context.Context) (Image, error)