xfer

Documentation

Index

• Constants
• Variables
• func IsExpectedWSCloseError(err error) bool
• type ControlHandler
• type ControlHandlerFunc
  • func (c ControlHandlerFunc) Handle(req Request, res *Response) error
• type Details
• type JSONWebsocketCodec
  • func NewJSONWebsocketCodec(conn Websocket) *JSONWebsocketCodec
  • func (j *JSONWebsocketCodec) Close() error
  • func (j *JSONWebsocketCodec) ReadRequestBody(v interface{}) error
  • func (j *JSONWebsocketCodec) ReadRequestHeader(r *rpc.Request) error
  • func (j *JSONWebsocketCodec) ReadResponseBody(v interface{}) error
  • func (j *JSONWebsocketCodec) ReadResponseHeader(r *rpc.Response) error
  • func (j *JSONWebsocketCodec) WaitForReadError() error
  • func (j *JSONWebsocketCodec) WriteRequest(r *rpc.Request, v interface{}) error
  • func (j *JSONWebsocketCodec) WriteResponse(r *rpc.Response, v interface{}) error
• type Message
• type Pipe
  • func NewPipe() Pipe
• type Request
• type Response
  • func ResponseError(err error) Response
  • func ResponseErrorf(format string, a ...interface{}) Response
• type WSDialer
• type Websocket
  • func DialWS(d WSDialer, urlStr string, requestHeader http.Header) (Websocket, *http.Response, error)
  • func Ping(c *websocket.Conn) Websocket
  • func Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (Websocket, error)

Constants

const (
	// AppPort is the default port that the app will use for its HTTP server.
	// The app publishes the API and user interface, and receives reports from
	// probes, on this port.
	AppPort = 4040

	// ScopeProbeIDHeader is the header we use to carry the probe's unique ID. The
	// ID is currently set to the a random string on probe startup.
	ScopeProbeIDHeader = "X-Scope-Probe-ID"
)

Variables

var ErrInvalidMessage = fmt.Errorf("Invalid Message")

ErrInvalidMessage is the error returned when the on-wire message is unexpected.

Functions

func IsExpectedWSCloseError

func IsExpectedWSCloseError(err error) bool

IsExpectedWSCloseError returns boolean indicating whether the error is a clean disconnection.

Types

type ControlHandler

type ControlHandler interface {
	Handle(req Request, res *Response) error
}

ControlHandler is interface used in the app and the probe to represent a control RPC.

type ControlHandlerFunc

type ControlHandlerFunc func(Request) Response

ControlHandlerFunc is a adapter (ala golang's http RequestHandlerFunc) for ControlHandler

func (ControlHandlerFunc) Handle

func (c ControlHandlerFunc) Handle(req Request, res *Response) error

Handle is an adapter method to make ControlHandlers exposable via golang rpc

type Details

type Details struct {
	ID       string `json:"id"`
	Version  string `json:"version"`
	Hostname string `json:"hostname"`
}

Details are some generic details that can be fetched from /api

type JSONWebsocketCodec

type JSONWebsocketCodec struct {
	sync.Mutex
	// contains filtered or unexported fields
}

JSONWebsocketCodec is golang rpc compatible Server and Client Codec that transmits and receives RPC messages over a websocker, as JSON.

func NewJSONWebsocketCodec

func NewJSONWebsocketCodec(conn Websocket) *JSONWebsocketCodec

NewJSONWebsocketCodec makes a new JSONWebsocketCodec

func (*JSONWebsocketCodec) Close

func (j *JSONWebsocketCodec) Close() error

Close implements rpc.ClientCodec and rpc.ServerCodec

func (*JSONWebsocketCodec) ReadRequestBody

func (j *JSONWebsocketCodec) ReadRequestBody(v interface{}) error

ReadRequestBody implements rpc.ServerCodec

func (*JSONWebsocketCodec) ReadRequestHeader

func (j *JSONWebsocketCodec) ReadRequestHeader(r *rpc.Request) error

ReadRequestHeader implements rpc.ServerCodec

func (*JSONWebsocketCodec) ReadResponseBody

func (j *JSONWebsocketCodec) ReadResponseBody(v interface{}) error

ReadResponseBody implements rpc.ClientCodec

func (*JSONWebsocketCodec) ReadResponseHeader

func (j *JSONWebsocketCodec) ReadResponseHeader(r *rpc.Response) error

ReadResponseHeader implements rpc.ClientCodec

func (*JSONWebsocketCodec) WaitForReadError

func (j *JSONWebsocketCodec) WaitForReadError() error

WaitForReadError blocks until any read on this codec returns an error. This is useful to know when the server has disconnected from the client.

func (*JSONWebsocketCodec) WriteRequest

func (j *JSONWebsocketCodec) WriteRequest(r *rpc.Request, v interface{}) error

WriteRequest implements rpc.ClientCodec

func (*JSONWebsocketCodec) WriteResponse

func (j *JSONWebsocketCodec) WriteResponse(r *rpc.Response, v interface{}) error

WriteResponse implements rpc.ServerCodec

type Message

type Message struct {
	Request  *rpc.Request
	Response *rpc.Response
	Value    interface{}
}

Message is the unions of Request, Response and arbitrary Value.

type Pipe

type Pipe interface {
	Ends() (io.ReadWriter, io.ReadWriter)
	CopyToWebsocket(io.ReadWriter, Websocket) error

	Close() error
	Closed() bool
	OnClose(func())
}

Pipe is a bi-directional channel from someone thing in the probe to the UI.

func NewPipe

func NewPipe() Pipe

NewPipe makes a new... pipe.

type Request

type Request struct {
	AppID   string
	NodeID  string
	Control string
}

Request is the UI -> App -> Probe message type for control RPCs

type Response

type Response struct {
	Value  interface{} `json:"value,omitempty"`
	Error  string      `json:"error,omitempty"`
	Pipe   string      `json:"pipe,omitempty"`
	RawTTY bool        `json:"raw_tty,omitempty"`
}

Response is the Probe -> App -> UI message type for the control RPCs.

func ResponseError

func ResponseError(err error) Response

ResponseError creates a new Response with the given error.

func ResponseErrorf

func ResponseErrorf(format string, a ...interface{}) Response

ResponseErrorf creates a new Response with the given formatted error string.

type WSDialer

type WSDialer interface {
	Dial(urlStr string, requestHeader http.Header) (*websocket.Conn, *http.Response, error)
}

WSDialer can dial a new websocket

type Websocket

type Websocket interface {
	ReadMessage() (messageType int, p []byte, err error)
	WriteMessage(messageType int, data []byte) error
	ReadJSON(v interface{}) error
	WriteJSON(v interface{}) error
	Close() error
}

Websocket exposes the bits of *websocket.Conn we actually use.

func DialWS

func DialWS(d WSDialer, urlStr string, requestHeader http.Header) (Websocket, *http.Response, error)

DialWS creates a new client connection. Use requestHeader to specify the origin (Origin), subprotocols (Sec-WebSocket-Protocol) and cookies (Cookie). Use the response.Header to get the selected subprotocol (Sec-WebSocket-Protocol) and cookies (Set-Cookie).

func Ping

func Ping(c *websocket.Conn) Websocket

Ping adds a periodic ping to a websocket connection.

func Upgrade

func Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (Websocket, error)

Upgrade upgrades the HTTP server connection to the WebSocket protocol.