serialbroker

type Approved struct {
	Name   string           // config name, e.g. "esp32"
	Device serialdev.Device // the resolved host device
	Record string           // "events" (default) or "full"
	// Baud is the initial line rate from moat.yaml's `baud:`. Zero means the
	// client's SET-BAUDRATE governs from the first command.
	Baud int
}

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

type Event struct {
	RunID  string
	Device string // config name, e.g. "esp32"
	Kind   string // attach, detach, error, conflict, settings, modem, control, break, purge
	Detail string

	DevicePath   string // host device node
	VID          string
	PID          string
	DeviceSerial string // the device's USB serial number, if it has one
	Record       string // record mode in force for this session

	TxBytes int64 // bytes sent to the container
	RxBytes int64 // bytes received from the container
}

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

type Options struct {
	// OpenPort opens a host serial device. Defaults to serialport.Open; tests
	// substitute a fake so no hardware is required.
	OpenPort func(path string) (serialport.Port, error)

	// Log receives session events. Optional.
	Log func(Event)

	// OpenRecorder returns a sink for captured payload bytes, used only when a
	// device is configured with record: full. Optional; without it, full
	// capture degrades to events only rather than failing the session.
	OpenRecorder func(runID, device string) (io.WriteCloser, error)

	// BindAddr is the fallback address for listeners when ListenOpts carries
	// none. Defaults to loopback — the only address safe to expose without
	// authentication. The run manager knows the container's gateway and passes
	// it per device; a broker configured for all interfaces is a deployment
	// choice that must be made explicitly, not a default.
	BindAddr string

	// HandshakeTimeout bounds how long an accepted connection may hold the
	// device without completing a negotiation, a com-port command, or sending
	// payload. Zero uses the default. See handshakeTimeout in session.go for
	// why this is an absolute budget rather than an idle timeout.
	HandshakeTimeout time.Duration
}