terminalws

Documentation

Index

• func Endpoint(baseURL string) (string, error)
• type Client
  • func Dial(ctx context.Context, endpoint string, sessionID string, options Options) (*Client, error)
  • func (c *Client) Attach(ctx context.Context, terminal io.ReadWriter, resizes <-chan Size) error
  • func (c *Client) Close() error
  • func (c *Client) Resize(ctx context.Context, size Size) error
  • func (c *Client) SendInput(ctx context.Context, payload []byte) error
• type HandshakeStatusError
  • func (e *HandshakeStatusError) Error() string
• type Options
• type Size

Functions

func Endpoint

func Endpoint(baseURL string) (string, error)

Types

type Client

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

func Dial

func Dial(ctx context.Context, endpoint string, sessionID string, options Options) (*Client, error)

func (*Client) Attach

func (c *Client) Attach(ctx context.Context, terminal io.ReadWriter, resizes <-chan Size) error

func (*Client) Close

func (c *Client) Close() error

func (*Client) Resize

func (c *Client) Resize(ctx context.Context, size Size) error

func (*Client) SendInput

func (c *Client) SendInput(ctx context.Context, payload []byte) error

type HandshakeStatusError

type HandshakeStatusError struct {
	StatusCode int
	Status     string
	Body       string
}

func (*HandshakeStatusError) Error

func (e *HandshakeStatusError) Error() string

type Options

type Options struct {
	Header http.Header
	Cols   uint32
	Rows   uint32
}

type Size

type Size struct {
	Cols uint32
	Rows uint32
}