desktop

package
v2.39.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for integration with Docker Desktop features.

func NewClient

func NewClient(apiEndpoint string) *Client

NewClient creates a Desktop integration client for the provided in-memory socket address (AF_UNIX or named pipe).

func NewFromDockerClient added in v2.26.0

func NewFromDockerClient(ctx context.Context, dockerCli command.Cli) (*Client, error)

NewFromDockerClient creates a Desktop Client using the Docker CLI client to auto-discover the Desktop CLI socket endpoint (if available).

An error is returned if there is a failure communicating with Docker Desktop, but even on success, a nil Client can be returned if the active Docker Engine is not a Desktop instance.

func (*Client) Close

func (c *Client) Close() error

Close releases any open connections.

func (*Client) Endpoint added in v2.26.0

func (c *Client) Endpoint() string

func (*Client) FeatureFlags added in v2.26.0

func (c *Client) FeatureFlags(ctx context.Context) (FeatureFlagResponse, error)

func (*Client) Ping

func (c *Client) Ping(ctx context.Context) (*PingResponse, error)

Ping is a minimal API used to ensure that the server is available.

type FeatureFlagResponse added in v2.26.0

type FeatureFlagResponse map[string]FeatureFlagValue

type FeatureFlagValue added in v2.26.0

type FeatureFlagValue struct {
	Enabled bool `json:"enabled"`
}

type PingResponse

type PingResponse struct {
	ServerTime int64 `json:"serverTime"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL