api

Jan 31, 2026

Changes in this version

type ServerConfig

+ Password string

+ RequireLocalHostAuth bool

Dec 30, 2025

Changes in this version

+ func ListDeviceTypes() []string

type Server

+ func (a *Server) Addr() string

Dec 6, 2025

Changes in this version

+ const DIGCF_DEVICEINTERFACE — windows/amd64

+ const DIGCF_PRESENT — windows/amd64

+ type SP_DEVICE_INTERFACE_DATA struct — windows/amd64

+ CbSize uint32

+ Flags uint32

+ InterfaceClassGuid windows.GUID

+ Reserved uintptr

+ type SP_DEVICE_INTERFACE_DETAIL_DATA struct — windows/amd64

+ CbSize uint32

+ DevicePath [1]uint16

Nov 23, 2025

Changes in this version

+ func AttachLocalhostClient(ctx context.Context, deviceExportMeta *usbip.ExportMeta, ...) error

+ func CheckAutoAttachPrerequisites(logger *slog.Logger) bool — linux/amd64, windows/amd64

+ func ErrBadRequest(detail string) *apitypes.ApiError

+ func ErrConflict(detail string) *apitypes.ApiError

+ func ErrInternal(detail string) *apitypes.ApiError

+ func ErrNotFound(detail string) *apitypes.ApiError

+ func RegisterDevice(name string, reg DeviceRegistration)

+ func WrapError(err error) *apitypes.ApiError

+ type DeviceRegistration interface

+ CreateDevice func(o *device.CreateOptions) usb.Device

+ StreamHandler func() StreamHandlerFunc

+ func GetRegistration(name string) DeviceRegistration

+ type HandlerFunc func(req *Request, res *Response, logger *slog.Logger) error

+ type Request struct

+ Ctx context.Context

+ Params map[string]string

+ Payload string

+ type Response struct

+ JSON string

+ type Router struct

+ func NewRouter() *Router

+ func (r *Router) Match(path string) (HandlerFunc, map[string]string)

+ func (r *Router) MatchStream(path string) (StreamHandlerFunc, map[string]string)

+ func (r *Router) Register(pattern string, handler HandlerFunc)

+ func (r *Router) RegisterStream(pattern string, handler StreamHandlerFunc)

+ type Server struct

+ func New(s *usb.Server, addr string, config ServerConfig, logger *slog.Logger) *Server

+ func (a *Server) Close()

+ func (a *Server) Config() ServerConfig

+ func (a *Server) Router() *Router

+ func (a *Server) Start() error

+ func (a *Server) USB() *usb.Server

+ type ServerConfig struct

+ Addr string

+ AutoAttachLocalClient bool

+ ConnectionTimeout time.Duration

+ DeviceHandlerConnectTimeout time.Duration

+ type StreamHandlerFunc func(conn net.Conn, dev *usb.Device, logger *slog.Logger) error

+ func DeviceStreamHandler(srv *usb.Server) StreamHandlerFunc

+ func GetStreamHandler(name string) StreamHandlerFunc