client

Documentation

Index

• type Client
  • func NewClient(socketPath string) Client
  • func (c *Client) Echo(msg string) string
  • func (c *Client) Exit()
  • func (c *Client) Install(item string) string
  • func (c *Client) Ping() string
  • func (c *Client) Run()
  • func (c *Client) Stop()
  • func (c *Client) Wait()

Types

type Client

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

Client is used to send commands to a local or remote gourdd

func NewClient

func NewClient(socketPath string) Client

NewClient creates a new client connected to a local gourdd

func (*Client) Echo

func (c *Client) Echo(msg string) string

Echo sends an echo command

func (*Client) Exit

func (c *Client) Exit()

Exit closes the connection to the local gourdd

func (*Client) Install

func (c *Client) Install(item string) string

Install sends an install command

func (*Client) Ping

func (c *Client) Ping() string

Ping sends a ping command

func (*Client) Run

func (c *Client) Run()

Run will make it so that the client can send commands

func (*Client) Stop

func (c *Client) Stop()

Stop prevents the client from sending commands

func (*Client) Wait

func (c *Client) Wait()

Wait will block a thread until the client stops sending commands