api

package

v1.1.2 Latest Latest Go to latest Published: Jan 2, 2017 License: MIT Imports: 9 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

This section is empty.

This section is empty.

This section is empty.

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

API contains routing and messagign capabilities. Valid HTTP requests to api.API are routed via rabbitmq to either kick off or report upon workflows.

func NewAPI(ampqURI, redisURI, host string, port int) (a API, err error)

NewAPI receives an ampquri for routing messages, a redisURI for configuring workflows, and a host and a port for listening on.

func (a API) Start()

Start starts a listener on API.listener Used for routing metadata, monitoring, and workflow requests.

type ErrorResponse struct {
	Message string
}

ErrorResponse is a placeholder for outgoing errors in responses

type Mon struct {
	// Job node's hostname
	Hostname            string
	EUID, GID, PID, UID int
	UTF8                string
}

Mon is a container of Monitoring/ Metadata for json marshaling

func NewMon() (m Mon)

NewMon initialises and returns a `Mon`, containing monitoring and metadata

type StartWorkflow struct {
	InitWorkflow StarterRequest
	Time         time.Time
	UUID         string
}

StartWorkflow contains the message structure that kicking off a workflow expects in a master TaskManager

type StarterRequest struct {
	Name      string
	Variables map[string]interface{}
}

StarterRequest is a placeholder for incoming 'start workflow' requests

type StarterResponse struct {
	UUID string
}

StarterResponse is a placeholder for outgoing 'start workflow' responses