mirror of
https://github.com/moby/moby.git
synced 2026-01-11 18:51:37 +00:00
4d20b6fe56
Move the option-types to the client and in some cases create a copy for the backend. These types are used to construct query- args, and not marshaled to JSON, and can be replaced with functional options in the client. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
63 lines
2.2 KiB
Go
63 lines
2.2 KiB
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
"net/url"
|
|
"strconv"
|
|
|
|
"github.com/moby/moby/api/types/versions"
|
|
)
|
|
|
|
// ContainerStopOptions holds the options to stop or restart a container.
|
|
type ContainerStopOptions struct {
|
|
// Signal (optional) is the signal to send to the container to (gracefully)
|
|
// stop it before forcibly terminating the container with SIGKILL after the
|
|
// timeout expires. If not value is set, the default (SIGTERM) is used.
|
|
Signal string `json:",omitempty"`
|
|
|
|
// Timeout (optional) is the timeout (in seconds) to wait for the container
|
|
// to stop gracefully before forcibly terminating it with SIGKILL.
|
|
//
|
|
// - Use nil to use the default timeout (10 seconds).
|
|
// - Use '-1' to wait indefinitely.
|
|
// - Use '0' to not wait for the container to exit gracefully, and
|
|
// immediately proceeds to forcibly terminating the container.
|
|
// - Other positive values are used as timeout (in seconds).
|
|
Timeout *int `json:",omitempty"`
|
|
}
|
|
|
|
// ContainerStop stops a container. In case the container fails to stop
|
|
// gracefully within a time frame specified by the timeout argument,
|
|
// it is forcefully terminated (killed).
|
|
//
|
|
// If the timeout is nil, the container's StopTimeout value is used, if set,
|
|
// otherwise the engine default. A negative timeout value can be specified,
|
|
// meaning no timeout, i.e. no forceful termination is performed.
|
|
func (cli *Client) ContainerStop(ctx context.Context, containerID string, options ContainerStopOptions) error {
|
|
containerID, err := trimID("container", containerID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
query := url.Values{}
|
|
if options.Timeout != nil {
|
|
query.Set("t", strconv.Itoa(*options.Timeout))
|
|
}
|
|
if options.Signal != "" {
|
|
// Make sure we negotiated (if the client is configured to do so),
|
|
// as code below contains API-version specific handling of options.
|
|
//
|
|
// Normally, version-negotiation (if enabled) would not happen until
|
|
// the API request is made.
|
|
if err := cli.checkVersion(ctx); err != nil {
|
|
return err
|
|
}
|
|
if versions.GreaterThanOrEqualTo(cli.version, "1.42") {
|
|
query.Set("signal", options.Signal)
|
|
}
|
|
}
|
|
resp, err := cli.post(ctx, "/containers/"+containerID+"/stop", query, nil, nil)
|
|
defer ensureReaderClosed(resp)
|
|
return err
|
|
}
|