agent

Documentation

Index

• Variables
• func CreatePidFile() error
• func InitAgentLogs() error
• func IsAgentStartError(err error) bool
• func IsHostNotFoundError(err error) bool
• func IsIPv6(addr string) bool
• func IsTunnelError(err error) bool
• func RemovePidFile() error
• func StopRunningAgent() error
• type AgentStartError
  • func (e *AgentStartError) Description() string
  • func (e *AgentStartError) Error() string
  • func (e *AgentStartError) Suggestion() string
• type Client
  • func DefaultClient(apiClient *api.Client) (*Client, error)
  • func Establish(ctx context.Context, apiClient *api.Client) (*Client, error)
  • func NewClient(path string, apiClient *api.Client) (*Client, error)
  • func StartDaemon(ctx context.Context, api *api.Client, command string) (*Client, error)
  • func (c *Client) Dialer(ctx context.Context, o *api.Organization) (Dialer, error)
  • func (c *Client) Establish(ctx context.Context, slug string) error
  • func (c *Client) Instances(ctx context.Context, o *api.Organization, app string) (*Instances, error)
  • func (c *Client) Kill(ctx context.Context) error
  • func (c *Client) Ping(ctx context.Context) (PingResponse, error)
  • func (c *Client) Probe(ctx context.Context, o *api.Organization) error
  • func (c *Client) Resolve(ctx context.Context, o *api.Organization, host string) (string, error)
  • func (c *Client) WaitForHost(ctx context.Context, o *api.Organization, host string) error
  • func (c *Client) WaitForTunnel(ctx context.Context, o *api.Organization) error
• type ClosableWrite
• type Dialer
• type HostNotFoundError
  • func (e *HostNotFoundError) Error() string
  • func (e *HostNotFoundError) Unwrap() error
• type Instances
• type PingResponse
• type Server
  • func DefaultServer(apiClient *api.Client, background bool) (*Server, error)
  • func NewServer(path string, apiClient *api.Client, background bool) (*Server, error)
  • func (s *Server) Serve()
  • func (s *Server) Stop()
  • func (s *Server) Wait()
• type TunnelError
  • func (e *TunnelError) Error() string
  • func (e *TunnelError) Unwrap() error

Variables

var (
	ErrCantBind          = errors.New("can't bind agent socket")
	ErrTunnelUnavailable = errors.New("tunnel unavailable")
)

var (
	ErrUnreachable = errors.New("can't connect to agent")
)

Functions

func CreatePidFile

func CreatePidFile() error

func InitAgentLogs

func InitAgentLogs() error

func IsAgentStartError

func IsAgentStartError(err error) bool

func IsHostNotFoundError

func IsHostNotFoundError(err error) bool

func IsIPv6

func IsIPv6(addr string) bool

func IsTunnelError

func IsTunnelError(err error) bool

func RemovePidFile

func RemovePidFile() error

func StopRunningAgent

func StopRunningAgent() error

Types

type AgentStartError

type AgentStartError struct {
	Output string
}

func (*AgentStartError) Description

func (e *AgentStartError) Description() string

func (*AgentStartError) Error

func (e *AgentStartError) Error() string

func (*AgentStartError) Suggestion

func (e *AgentStartError) Suggestion() string

type Client

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

func DefaultClient

func DefaultClient(apiClient *api.Client) (*Client, error)

func Establish

func Establish(ctx context.Context, apiClient *api.Client) (*Client, error)

/ Establish starts the daemon if necessary and returns a client

func NewClient

func NewClient(path string, apiClient *api.Client) (*Client, error)

func StartDaemon

func StartDaemon(ctx context.Context, api *api.Client, command string) (*Client, error)

func (*Client) Dialer

func (c *Client) Dialer(ctx context.Context, o *api.Organization) (Dialer, error)

func (*Client) Establish

func (c *Client) Establish(ctx context.Context, slug string) error

func (*Client) Instances

func (c *Client) Instances(ctx context.Context, o *api.Organization, app string) (*Instances, error)

func (*Client) Kill

func (c *Client) Kill(ctx context.Context) error

func (*Client) Ping

func (c *Client) Ping(ctx context.Context) (PingResponse, error)

func (*Client) Probe

func (c *Client) Probe(ctx context.Context, o *api.Organization) error

func (*Client) Resolve

func (c *Client) Resolve(ctx context.Context, o *api.Organization, host string) (string, error)

func (*Client) WaitForHost

func (c *Client) WaitForHost(ctx context.Context, o *api.Organization, host string) error

func (*Client) WaitForTunnel

func (c *Client) WaitForTunnel(ctx context.Context, o *api.Organization) error

type ClosableWrite

type ClosableWrite interface {
	CloseWrite() error
}

type Dialer

type Dialer interface {
	DialContext(ctx context.Context, network, addr string) (net.Conn, error)
}

type HostNotFoundError

type HostNotFoundError struct {
	OrgSlug string
	Host    string
	Err     error
}

func (*HostNotFoundError) Error

func (e *HostNotFoundError) Error() string

func (*HostNotFoundError) Unwrap

func (e *HostNotFoundError) Unwrap() error

type Instances

type Instances struct {
	Labels    []string
	Addresses []string
}

type PingResponse

type PingResponse struct {
	PID        int
	Version    semver.Version
	Background bool
}

type Server

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

func DefaultServer

func DefaultServer(apiClient *api.Client, background bool) (*Server, error)

func NewServer

func NewServer(path string, apiClient *api.Client, background bool) (*Server, error)

func (*Server) Serve

func (s *Server) Serve()

func (*Server) Stop

func (s *Server) Stop()

func (*Server) Wait

func (s *Server) Wait()

type TunnelError

type TunnelError struct {
	OrgSlug string
	Err     error
}

func (*TunnelError) Error

func (e *TunnelError) Error() string

func (*TunnelError) Unwrap

func (e *TunnelError) Unwrap() error