machine

Documentation

Index

• type Machine
  • func New(sdcp *sdcp.SDCP, logger types.Logger) *Machine
  • func (a *Machine) App() *fiber.App
  • func (a *Machine) Attributes(ctx *fiber.Ctx) error
  • func (a *Machine) DisableVideo(ctx *fiber.Ctx) error
  • func (a *Machine) EnableVideo(ctx *fiber.Ctx) error
  • func (a *Machine) RefreshAttributes(ctx *fiber.Ctx) error
  • func (a *Machine) RefreshStatus(ctx *fiber.Ctx) error
  • func (a *Machine) Register(ctx *fiber.Ctx) error
  • func (a *Machine) Status(ctx *fiber.Ctx) error
  • func (a *Machine) Unregister(ctx *fiber.Ctx) error

Types

type Machine

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

func New

func New(sdcp *sdcp.SDCP, logger types.Logger) *Machine

func (*Machine) App

func (a *Machine) App() *fiber.App

func (*Machine) Attributes

func (a *Machine) Attributes(ctx *fiber.Ctx) error

Attributes godoc @Description Retrieves the attributes of a machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} models.MachineAttributesResponse @Failure 400 {string} string @Failure 404 {string} string @Failure 500 {string} string @Router /machine/attributes/{id} [get]

func (*Machine) DisableVideo

func (a *Machine) DisableVideo(ctx *fiber.Ctx) error

DisableVideo godoc @Description Disables Video streaming on a machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} models.MachineVideoResponse @Failure 400 {string} string @Failure 404 {string} string @Failure 500 {string} string @Router /machine/video/{id} [delete]

func (*Machine) EnableVideo

func (a *Machine) EnableVideo(ctx *fiber.Ctx) error

EnableVideo godoc @Description Enables Video streaming on a machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} models.MachineVideoResponse @Failure 400 {string} string @Failure 404 {string} string @Failure 500 {string} string @Router /machine/video/{id} [post]

func (*Machine) RefreshAttributes

func (a *Machine) RefreshAttributes(ctx *fiber.Ctx) error

RefreshAttributes godoc @Description Refreshes and retrieves the attributes of a machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} models.MachineAttributesResponse @Failure 400 {string} string @Failure 404 {string} string @Failure 500 {string} string @Router /machine/attributes/{id} [post]

func (*Machine) RefreshStatus

func (a *Machine) RefreshStatus(ctx *fiber.Ctx) error

RefreshStatus godoc @Description Refreshes and retrieves the status of a machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} models.MachineStatusResponse @Failure 400 {string} string @Failure 404 {string} string @Failure 500 {string} string @Router /machine/status/{id} [post]

func (*Machine) Register

func (a *Machine) Register(ctx *fiber.Ctx) error

Register godoc @Description Registers a new machine @Tags machine @Accept application/json @Produce application/json @Param request body models.MachineRegisterRequest true "Machine Register Request" @Success 200 {object} models.MachineStatusResponse @Failure 400 {string} string @Failure 500 {string} string @Router /machine/register [post]

func (*Machine) Status

func (a *Machine) Status(ctx *fiber.Ctx) error

Status godoc @Description Retrieves the status of a machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} models.MachineStatusResponse @Failure 400 {string} string @Failure 404 {string} string @Failure 500 {string} string @Router /machine/status/{id} [get]

func (*Machine) Unregister

func (a *Machine) Unregister(ctx *fiber.Ctx) error

Unregister godoc @Description Unregisters an existing machine @Tags machine @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {string} string @Failure 400 {string} string @Failure 500 {string} string @Router /machine/unregister/{id} [post]