client

Documentation

Overview

Package client provides the low level assembly of the Notifiarr client application. This package orchestrates reading in of configuration, parsing cli flags, actioning those cli flags, setting up logging, and finally the starting of internal service routines for the webserver, plex sessions, snapshots, service checks and others. This package sets everything up for the client application.

Index

• Variables
• func Start() error
• type Client
  • func (c *Client) AutoWatchUpdate()
  • func (c *Client) Exit() error
  • func (c *Client) ParseGUITemplates() (err error)
  • func (c *Client) PrintStartupInfo(clientInfo *notifiarr.ClientInfo)
  • func (c *Client) StartWebServer()
  • func (c *Client) StopWebServer() error

Variables

var (
	ErrInvalidHeader = fmt.Errorf("invalid header provided; must contain a colon")
)

Errors.

var (
	ErrNilAPIKey = fmt.Errorf("API key may not be empty: set a key in config file, OR with environment variable")
)

Errors returned by this package.

var ErrNoServer = fmt.Errorf("the web server is not running, cannot stop it")

ErrNoServer returns when the server is already stopped and a stop req occurs.

Functions

func Start

func Start() error

Start runs the app.

Types

type Client

type Client struct {
	*logs.Logger
	Flags  *configfile.Flags
	Config *configfile.Config

	// this locks anything that may be updated while running.
	// at least "UIPassword" as of its creation.
	sync.RWMutex
	// contains filtered or unexported fields
}

Client stores all the running data.

func (*Client) AutoWatchUpdate

func (c *Client) AutoWatchUpdate()

AutoWatchUpdate is not used on this OS.

func (*Client) Exit

func (c *Client) Exit() error

Exit stops the web server and logs our exit messages. Start() calls this.

func (*Client) ParseGUITemplates

func (c *Client) ParseGUITemplates() (err error)

ParseGUITemplates parses the baked-in templates, and overrides them if a template directory is provided.

func (*Client) PrintStartupInfo

func (c *Client) PrintStartupInfo(clientInfo *notifiarr.ClientInfo)

PrintStartupInfo prints info about our startup config. This runs once on startup, and again during reloads.

func (*Client) StartWebServer

func (c *Client) StartWebServer()

StartWebServer starts the web server.

func (*Client) StopWebServer

func (c *Client) StopWebServer() error

StopWebServer stops the web servers. Panics if that causes an error or timeout.