client/ping.go

   1 package client
   2
   3 import (
   4         "github.com/docker/docker/api/types"
   5         "golang.org/x/net/context"
   6 )
   7
   8 // Ping pings the server and returns the value of the "Docker-Experimental", "OS-Type" & "API-Version" headers
   9 func (cli *Client) Ping(ctx context.Context) (types.Ping, error) {
  10         var ping types.Ping
  11         req, err := cli.buildRequest("GET", cli.basePath+"/_ping", nil, nil)
  12         if err != nil {
  13                 return ping, err
  14         }
  15         serverResp, err := cli.doRequest(ctx, req)
  16         if err != nil {
  17                 return ping, err
  18         }
  19         defer ensureReaderClosed(serverResp)
  20
  21         if serverResp.header != nil {
  22                 ping.APIVersion = serverResp.header.Get("API-Version")
  23
  24                 if serverResp.header.Get("Docker-Experimental") == "true" {
  25                         ping.Experimental = true
  26                 }
  27                 ping.OSType = serverResp.header.Get("OSType")
  28         }
  29
  30         err = cli.checkResponseErr(serverResp)
  31         return ping, err
  32 }