Skip to content
rodeo

client

local client = require("@rodeo-client-lune/client")

Summary

Section titled “Summary”
EntryDescription
BackendInfo
ConnectOpts
ProcessInfo
RodeoClient

Types

Section titled “Types”

BackendInfo

Section titled “BackendInfo”
type BackendInfo = { id: string, kind: string, name: string }

ConnectOpts

Section titled “ConnectOpts”
type ConnectOpts = {
  host: string?,
  port: number,
  rodeoBin: string?,
  -- Max time to wait for the server to come up. Default 30000ms.
  readyTimeoutMs: number?,
  -- Poll interval while waiting for the server. Default 200ms.
  readyPollMs: number?,
}

ProcessInfo

Section titled “ProcessInfo”
type ProcessInfo = { [string]: any }

RodeoClient

Section titled “RodeoClient”
type RodeoClient = {
  getState: () -> StateSnapshot,
  listProcesses: () -> { ProcessInfo },
  kill: (processId: number) -> (),
  listBackends: (kind: string?) -> { BackendInfo },
  getLocalStudio: () -> studioMod.StudioBackend,
  getStudio: (idOrName: string) -> studioMod.StudioBackend,
  getVms: () -> { vmMod.Vm },
  getVm: (vmId: string) -> vmMod.Vm,
  close: () -> (),
}