client

package

v0.0.0-...-d942e53 Latest Latest Go to latest Published: Jan 19, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/interactive-instruments/xtraplatform-cli

Documentation ¶

Index ¶

Constants
func HasStatus(results []Result, status Status) bool
func Init(handle_command CommandHandler, progress_chan chan string)
func OpenWebsocket(store2 Store, port string)
func PrintResults(results []Result, err error)
type CommandHandler
type Response
type Result
type Status
type Store
- func New(source *string, driver *string, verbose *bool, debug *bool) *Store

Constants ¶

View Source

const WS_CLOSED = "WS_CLOSED"

Variables ¶

This section is empty.

Functions ¶

func HasStatus ¶

func HasStatus(results []Result, status Status) bool

func Init ¶

func Init(handle_command CommandHandler, progress_chan chan string)

func OpenWebsocket ¶

func OpenWebsocket(store2 Store, port string)

func PrintResults ¶

func PrintResults(results []Result, err error)

PrintResults prints the results to the console

Types ¶

type CommandHandler ¶

type CommandHandler func(command string) string

type Response ¶

type Response struct {
	Results *[]Result
	Error   *string
}

type Result ¶

type Result struct {
	Status  Status
	Message *string
}

type Status ¶

type Status int

const (
	Unknown Status = iota
	Error
	Warning
	Success
	Info
	Confirmation
)

func (Status) MarshalJSON ¶

func (s Status) MarshalJSON() ([]byte, error)

MarshalJSON must be a *value receiver* to ensure that a Suit on a parent object does not have to be a pointer in order to have it correctly marshaled.

func (Status) String ¶

func (s Status) String() string

String allows Suit to implement fmt.Stringer

func (*Status) UnmarshalJSON ¶

func (s *Status) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON must be a *pointer receiver* to ensure that the indirect from the parsed value can be set on the unmarshaling object. This means that the ParseSuit function must return a *value* and not a pointer.

type Store ¶

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

Store is

func New ¶

func New(source *string, driver *string, verbose *bool, debug *bool) *Store

New is

func (Store) Connect ¶

func (store Store) Connect() error

Connect is

func (Store) Handle ¶

func (store Store) Handle(parameters map[string]interface{}, command string, subcommands ...string) ([]Result, error)

Handle is

func (Store) Label ¶

func (store Store) Label() string

Label is

func (Store) Request ¶

func (store Store) Request(request []byte) (response []byte)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL