client

Documentation

Overview

Package client provides helpers for interacting with the wash socket HTTP API.

Index

• type Client
  • func ForUNIXSocket(pathToSocket string) Client

Types

type Client

type Client interface {
	Info(path string) (apitypes.Entry, error)
	List(path string) ([]apitypes.Entry, error)
	Metadata(path string) (map[string]interface{}, error)
	Stream(path string) (io.ReadCloser, error)
	Exec(path string, command string, args []string, opts apitypes.ExecOptions) (<-chan apitypes.ExecPacket, error)
	History(bool) (chan apitypes.Activity, error)
	ActivityJournal(index int, follow bool) (io.ReadCloser, error)
	Clear(path string) ([]string, error)
	// A "nil" schema means that the schema's unknown.
	Schema(path string) (*apitypes.EntrySchema, error)
	Screenview(name string, params analytics.Params) error
	Delete(path string) (bool, error)
	Signal(path string, signal string) error
}

Client represents a Wash API client.

func ForUNIXSocket

func ForUNIXSocket(pathToSocket string) Client

ForUNIXSocket returns a client suitable for making wash API calls over a UNIX domain socket.