rest

Documentation

Index

• type Endpoint
  • func NewEndpoint(input string) (*Endpoint, error)
  • func (ep *Endpoint) ToCmdLine() ([]string, error)
• type ServiceScheme
• type VFKitService
  • func NewServer(inspector VirtualMachineInspector, stateHandler VirtualMachineStateHandler, ...) (*VFKitService, error)
  • func (v *VFKitService) Start()
• type VirtualMachineInspector
• type VirtualMachineStateHandler

Types

type Endpoint

type Endpoint struct {
	Host   string
	Path   string
	Scheme ServiceScheme
}

func NewEndpoint

func NewEndpoint(input string) (*Endpoint, error)

func (*Endpoint) ToCmdLine

func (ep *Endpoint) ToCmdLine() ([]string, error)

type ServiceScheme

type ServiceScheme int

const (
	TCP ServiceScheme = iota
	Unix
	None
	HTTP
)

type VFKitService

type VFKitService struct {
	*Endpoint
	// contains filtered or unexported fields
}

VFKitService is used for the restful service; it describes the variables of the service like host/path but also has the router object

func NewServer

func NewServer(inspector VirtualMachineInspector, stateHandler VirtualMachineStateHandler, endpoint string) (*VFKitService, error)

NewServer creates a new restful service

func (*VFKitService) Start

func (v *VFKitService) Start()

Start initiates the already configured gin service

type VirtualMachineInspector

type VirtualMachineInspector interface {
	Inspect(c *gin.Context)
}

type VirtualMachineStateHandler

type VirtualMachineStateHandler interface {
	GetVMState(c *gin.Context)
	SetVMState(c *gin.Context)
}