client

Documentation

Overview

This package provides an HTTP client to use with pm-enabled processes.

Index

• type Client
  • func NewClient(uri string) *Client
  • func (c *Client) History(id string) (*pm.HistoryResponse, error)
  • func (c *Client) Kill(id, message string) error
  • func (c *Client) Processes() (*pm.ProcResponse, error)

Types

type Client

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

func NewClient

func NewClient(uri string) *Client

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

func (*Client) History

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 (*Client) Kill

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 (*Client) Processes

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.