client

package

v0.0.0-...-baa672f Latest Latest Go to latest Published: Dec 15, 2020 License: MIT Imports: 6 Imported by: 1

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 package provides an HTTP client to use with pm-enabled processes.

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	*http.Client
	BaseURI string
	Headers map[string]string
}

func NewClient(uri string) *Client

NewClient returns a new client set to connect to the given URI.

func (c *Client) History(id string) (*pm.HistoryResponse, error)

History issues a GET to /proc/<id>/history for a given id, thus returning the complete history for the task <id> at the server.

func (c *Client) Kill(id, message string) error

Kill requests the cancellation of a given task. Note that it will effectively be cancelled as soon as the task reaches its next cancellation point.

func (c *Client) Processes() (*pm.ProcResponse, error)

Processes issues a GET to /proc, thus retrieving the full process list from the server. The result is provided as a ProcResponse.