github.com/zhouyu0/docker-note@v0.0.0-20190722021225-b8d3825084db/client/ping.go (about)

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