shuttle

package

v0.24.5 Latest Latest Go to latest Published: May 15, 2024 License: BSD-3-Clause Imports: 21 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

Package shuttle turns json based requests into game play. ex. for playing via a webserver.

This section is empty.

This section is empty.

This section is empty.

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

func (out *Collector) GetEvents() (ret []frame.Event)

returns and clears all events

type Endpoint int

Destinations for POST ( different State(s) may respond to in different ways to the same endpoint

not very RESTful... fine for now )

const (
	Restart Endpoint = iota // restart
	Query                   // query
)

maybe also "$weave", "$shutdown" ... note: instead of sending "input" we send a fabricate command.....

func (i Endpoint) String() string

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

do we really need all these things?

func NewShuttle(inFile string, opts qna.Options) (ret Shuttle, err error)

func (c *Shuttle) Close()

func (c *Shuttle) EnsurePlay() (ret *play.Playtime, err error)

create the playtime if it doesnt exist

func (c *Shuttle) Post(w io.Writer, endpoint string, msg json.RawMessage) (err error)

func (c *Shuttle) Restart(scene string) (ret *play.Playtime, err error)