diff options
author | Jhon Honce <jhonce@redhat.com> | 2019-03-04 17:21:23 -0700 |
---|---|---|
committer | Jhon Honce <jhonce@redhat.com> | 2019-03-06 10:32:01 -0700 |
commit | 8a6758d5fdaba9e6ec58eeb23ee5123762c18b72 (patch) | |
tree | 4273a61b912797dc6cb4d27fb6743c5367a1dfa8 /API.md | |
parent | c6c0b54c361df623378706ca5e41faac309ab7ac (diff) | |
download | podman-8a6758d5fdaba9e6ec58eeb23ee5123762c18b72.tar.gz podman-8a6758d5fdaba9e6ec58eeb23ee5123762c18b72.tar.bz2 podman-8a6758d5fdaba9e6ec58eeb23ee5123762c18b72.zip |
Implement podman-remote wait command and container subcommand
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'API.md')
-rwxr-xr-x | API.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -143,7 +143,7 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func VolumesPrune() []string, []string](#VolumesPrune) -[func WaitContainer(name: string) int](#WaitContainer) +[func WaitContainer(name: string, interval: int) int](#WaitContainer) [type BuildInfo](#BuildInfo) @@ -1013,10 +1013,10 @@ VolumesPrune removes unused volumes on the host ### <a name="WaitContainer"></a>func WaitContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method WaitContainer(name: [string](https://godoc.org/builtin#string)) [int](https://godoc.org/builtin#int)</div> -WaitContainer takes the name or ID of a container and waits until the container stops. Upon stopping, the return -code of the container is returned. If the container container cannot be found by ID or name, -a [ContainerNotFound](#ContainerNotFound) error is returned. +method WaitContainer(name: [string](https://godoc.org/builtin#string), interval: [int](https://godoc.org/builtin#int)) [int](https://godoc.org/builtin#int)</div> +WaitContainer takes the name or ID of a container and waits the given interval in milliseconds until the container +stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID +or name, a [ContainerNotFound](#ContainerNotFound) error is returned. ## Types ### <a name="BuildInfo"></a>type BuildInfo |