package socket

import "github.com/docker/cli/cli-plugins/socket"

Index ¶

• Constants
• func ConnectAndWait(cb func())
• func SetupConn(conn **net.UnixConn) (string, error)

Constants ¶

const EnvKey = "DOCKER_CLI_PLUGIN_SOCKET"

EnvKey represents the well-known environment variable used to pass the plugin being executed the socket name it should listen on to coordinate with the host CLI.

Functions ¶

func ConnectAndWait ¶

func ConnectAndWait(cb func())

ConnectAndWait connects to the socket passed via well-known env var, if present, and attempts to read from it until it receives an EOF, at which point cb is called.

func SetupConn ¶

func SetupConn(conn **net.UnixConn) (string, error)

SetupConn sets up a Unix socket listener, establishes a goroutine to handle connections and update the conn pointer, and returns the environment variable to pass to the plugin.

Source Files ¶

socket.go socket_darwin.go