renderer

Documentation

Index

• type Logger
  • func (l *Logger) Start(wg *sync.WaitGroup, rp chan protocol.RequestPayload, q chan int, e chan int)
• type Printer
  • func (p *Printer) Start(wg *sync.WaitGroup, rp chan protocol.RequestPayload, q chan int, e chan int)
• type Renderer
• type Web
  • func (web *Web) Start(wg *sync.WaitGroup, rp chan protocol.RequestPayload, q chan int, e chan int)

Types

type Logger

type Logger struct {
	// FilePathis the path to the log file which we write to.
	// Default is blank unless passed as a flag to the CLI.
	FilePath string

	// Details will log the headers with the request. Default is false unless the
	// flag is passed.
	Details bool

	// Address and Port are used for the start text
	Addr string
	Port int

	// Protocol is the protocol the web UI server will use.
	Protocol string
	// contains filtered or unexported fields
}

Logger outputs to a log file.

func (*Logger) Start

func (l *Logger) Start(wg *sync.WaitGroup, rp chan protocol.RequestPayload, q chan int, e chan int)

Start writes the initial server start to the log file.

type Printer

type Printer struct {
	// Spinner is a constant, we set it during the start method and can later stop it when we exit.
	Spinner *pterm.SpinnerPrinter

	// Details will output the headers with the request. Default is false unless the
	// flag is passed.
	Details bool
}

Printer is our CLI output that currently uses pterm. See https://github.com/pterm/pterm for more info on pterm.

func (*Printer) Start

func (p *Printer) Start(wg *sync.WaitGroup, rp chan protocol.RequestPayload, q chan int, e chan int)

Start renders the spinner and starts receive incoming requests from the channel.

type Renderer

type Renderer interface {
	// Start is called when we start our server.
	Start(*sync.WaitGroup, chan protocol.RequestPayload, chan int, chan int)
}

Renderer contains the interface which our servers use to render the output.

type Web

type Web struct {
	// Address is the address the web UI server will bind to.
	Address string

	// BuildInfo contains build information.
	BuildInfo map[string]string

	// Port is the port the web UI server will run on.
	Port int

	// Protocol is the protocol the web UI server will use.
	Protocol string

	// These are used for showing information about the request endpoint in the
	// web UI.
	ResponseCode int
	RequestAddr  string
	RequestPort  int

	StaticFiles http.FileSystem
	// contains filtered or unexported fields
}

Web is the renderer for the web UI.

func (*Web) Start

func (web *Web) Start(wg *sync.WaitGroup, rp chan protocol.RequestPayload, q chan int, e chan int)