cmdservice

Documentation

Overview

Package cmdservice implements hosting of command-sets which can be called by clients via an HTTP-based API.

Index

• func Register(ctx context.Context, service string, req commands.HostCommandSet) error
• func Wrap(f func(ipc.MessageContext) ipc.Response) webservice.HandlerFunc
• type BP
  • func Boilerplate(name string) *BP
  • func (bp *BP) Run(sets ...Set)
• type Command
  • func Based(base commands.Command, f func(ipc.MessageContext) ipc.Response) Command
  • func Simple(invoke []string, f func(ipc.MessageContext) ipc.Response) Command
• type Set

Functions

func Register

func Register(ctx context.Context, service string, req commands.HostCommandSet) error

func Wrap

func Wrap(f func(ipc.MessageContext) ipc.Response) webservice.HandlerFunc

Types

type BP

type BP struct {
	Name       string
	Service    string
	Bind, Self string
	WS         *webservice.Server
}

func Boilerplate

func Boilerplate(name string) *BP

func (*BP) Run

func (bp *BP) Run(sets ...Set)

type Command

type Command struct {
	commands.Command
	Handler webservice.HandlerFunc
}

func Based

func Based(base commands.Command, f func(ipc.MessageContext) ipc.Response) Command

func Simple

func Simple(invoke []string, f func(ipc.MessageContext) ipc.Response) Command

type Set

type Set struct {
	Platform string
	ID       string
	Tag      string
	Commands []Command
	Whisper  bool
}