Ruby SDK VSock reference

See Host sockets for guest connection details, platform support, and security considerations.

VSock routes are local-only and unavailable with the multi-tenant deployment profile.

SandboxBuilder

builder.vsock()

builder.vsock(host_path, port) # => SandboxBuilder

Example

sandbox = Microsandbox::Sandbox.builder("worker")
  .image("alpine")
  .vsock("/run/host-api.sock", 5000)
  .create

Expose a host Unix stream socket or local Windows named pipe on host CID 2. Call repeatedly to add routes; each socket type and port pair must be unique.

Parameters

host_pathString

Absolute path to the host socket or pipe.

portInteger

Port exposed to the guest.

Returns

SandboxBuilder

The builder, for chaining.

builder.vsock_dgram()

builder.vsock_dgram(host_path, port) # => SandboxBuilder

Expose a host Unix datagram socket while preserving datagram boundaries. Datagram routes are unavailable on Windows. Call repeatedly to add routes; each socket type and port pair must be unique.

Parameters

host_pathString

Absolute path to the host socket or pipe.

portInteger

Port exposed to the guest.

Returns

SandboxBuilder

The builder, for chaining.

⌘I

Getting Started

SDKs

CLI

VSock

SandboxBuilder

builder.vsock()

builder.vsock_dgram()

​SandboxBuilder

​builder.vsock()

​builder.vsock_dgram()

SandboxBuilder

builder.vsock()

builder.vsock_dgram()