client

package

v0.0.0-...-0b75b2d Latest Latest Go to latest Published: May 4, 2021 License: Apache-2.0 Imports: 19 Imported by: 8

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	UnixSocketScheme  = "unix"
	VSockSocketScheme = "vsock"
	HybridVSockScheme = "hvsock"
)

This section is empty.

func HybridVSockDialer(sock string, timeout time.Duration) (net.Conn, error)

HybridVSockDialer dials to a hybrid virtio socket

type AgentClient struct {
	agentgrpc.AgentServiceClient
	agentgrpc.HealthClient
	// contains filtered or unexported fields
}

AgentClient is an agent gRPC client connection wrapper for agentgrpc.AgentServiceClient

func NewAgentClient(ctx context.Context, sock string, enableYamux bool) (*AgentClient, error)

NewAgentClient creates a new agent gRPC client and handles both unix and vsock addresses.

Supported sock address formats are:

unix://<unix socket path>
vsock://<cid>:<port>
<unix socket path>
hvsock://<path>:<port>. Firecracker implements the virtio-vsock device model, and mediates communication between AF_UNIX sockets (on the host end) and AF_VSOCK sockets (on the guest end).

func (c *AgentClient) Close() error

Close an existing connection to the agent gRPC server.