client

Documentation

Index

• type Client
  • func New(appName string) (*Client, error)
  • func (c *Client) Call(req *api.ClientOriginatedMessage) (*api.ServerOriginatedMessage, error)
  • func (c *Client) Close() error

Types

type Client

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

Client wraps a websocket client connection to iTerm2. Must be instantiated with NewClient.

func New

func New(appName string) (*Client, error)

New returns a new websocket connection that talks to the iTerm2 application.New Callers must call the Close() method when done. The cookie parameter is optional. If provided, it will bypass script authentication prompts.

func (*Client) Call

func (c *Client) Call(req *api.ClientOriginatedMessage) (*api.ServerOriginatedMessage, error)

Call sends a request to the iTerm2 server

func (*Client) Close

func (c *Client) Close() error

Close closes the websocket connection and frees any goroutine resources