vsock

package

v0.0.0-...-8be290c Latest Latest Go to latest Published: Dec 24, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

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

Repository

github.com/khulnasoft-lab/hyvsock

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package vsock provides the Linux guest bindings to VM sockets. VM sockets are a generic mechanism for guest<->host communication. It was originally developed for VMware but now also supports virtio sockets and (soon) Hyper-V sockets.

The main purpose is to provide bindings to the Linux implementation of VM sockets, based on the low level support in golang.org/x/sys/unix.

The package also provides bindings to the host interface to virtio sockets for HyperKit on macOS.

Index ¶

Constants
func Listen(cid, port uint32) (net.Listener, error)
func SocketMode(m string)
type Addr
- func (a Addr) Network() string
- func (a Addr) String() string
type Conn
- func Dial(cid, port uint32) (Conn, error)

Constants ¶

View Source

const (
	// CIDAny is a wildcard CID
	CIDAny = 4294967295 // 2^32-1
	// CIDHypervisor is the reserved CID for the Hypervisor
	CIDHypervisor = 0
	// CIDHost is the reserved CID for the host system
	CIDHost = 2
)

Variables ¶

This section is empty.

Functions ¶

func Listen ¶

func Listen(cid, port uint32) (net.Listener, error)

Listen returns a net.Listener which can accept connections on the given port

func SocketMode ¶

func SocketMode(m string)

SocketMode is a NOOP on Linux

Types ¶

type Addr ¶

type Addr struct {
	CID  uint32
	Port uint32
}

Addr represents the address of a vsock end point.

func (Addr) Network ¶

func (a Addr) Network() string

Network returns the network type for a Addr

func (Addr) String ¶

func (a Addr) String() string

String returns a string representation of a Addr

type Conn ¶

type Conn interface {
	net.Conn
	CloseRead() error
	CloseWrite() error
	File() (*os.File, error)
}

Conn is a vsock connection which supports half-close.

func Dial ¶

func Dial(cid, port uint32) (Conn, error)

Dial connects to the CID.Port via virtio sockets

Source Files ¶

View all Source files

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