display

Documentation

Index

• type Config
• type Display
  • func NewDisplay(config Config) *Display
  • func (display *Display) Clear()
  • func (display *Display) Display(gd GenericData)
  • func (display *Display) EventChan() chan event.Event
  • func (display *Display) Fini()
  • func (display *Display) Resize(width, height int)
• type GenericData
• type HelpType
  • func (h HelpType) Description() string
  • func (h HelpType) EmptyRowContent() string
  • func (h HelpType) FirstCollectTime() time.Time
  • func (h HelpType) HaveRelativeStats() bool
  • func (h HelpType) Headings() string
  • func (h HelpType) LastCollectTime() time.Time
  • func (h HelpType) RowContent() []string
  • func (h HelpType) TotalRowContent() string

Types

type Config

type Config interface {
	Hostname() string
	MySQLVersion() string
	WantRelativeStats() bool
	Uptime() int
}

Config provides the interfce to some required configuration settings needed by Display

type Display

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

Display contains screen specific display information

func NewDisplay

func NewDisplay(config Config) *Display

NewDisplay returns a Display with an empty terminal

func (*Display) Clear

func (display *Display) Clear()

Clear clears the screen and flushes out the result to the terminal

func (*Display) Display

func (display *Display) Display(gd GenericData)

Display displays the wanted view to the screen

func (*Display) EventChan

func (display *Display) EventChan() chan event.Event

EventChan creates a channel of display events and run a poller to send these events to the channel. Return the channel which the application can use

func (*Display) Fini

func (display *Display) Fini()

Fini is called prior to finishing using the display

func (*Display) Resize

func (display *Display) Resize(width, height int)

Resize records the new size of the screen and clears it

type GenericData

type GenericData interface {
	Description() string         // description of the information being displayed
	Headings() string            // headings for the data
	FirstCollectTime() time.Time // initial time data was collected
	LastCollectTime() time.Time  // last time data was collected
	RowContent() []string        // a slice of rows of content
	TotalRowContent() string     // a string containing the details of a single row
	EmptyRowContent() string     // a string containing the details of an empty row
	HaveRelativeStats() bool     // does this data type have relative statistics
}

GenericData is a generic interface to data collected from P_S (multiple rows)

type HelpType

type HelpType struct{}

HelpType is a help information provided by the genric interface

var Help HelpType // empty initialisation should be ok for providing help

func (HelpType) Description

func (h HelpType) Description() string

func (HelpType) EmptyRowContent

func (h HelpType) EmptyRowContent() string

func (HelpType) FirstCollectTime

func (h HelpType) FirstCollectTime() time.Time

func (HelpType) HaveRelativeStats

func (h HelpType) HaveRelativeStats() bool

func (HelpType) Headings

func (h HelpType) Headings() string

func (HelpType) LastCollectTime

func (h HelpType) LastCollectTime() time.Time

func (HelpType) RowContent

func (h HelpType) RowContent() []string

func (HelpType) TotalRowContent

func (h HelpType) TotalRowContent() string