web

Documentation

Index

• Variables
• type Handler
• type Request
• type Response
• type State

Variables

var BufferStatusHandler bufferStatusHandler

var (
	// ErrParser is thrown when a request object is of the wrong type
	ErrParser error = errParse{}
)

var HomeHandler homeHandler

var MP3StreamHandler mp3StreamHandler

var NowPlayingHandler nowPlayingHandler

var StatusHandler statusHandler

var WAVStreamHandler wavStreamHandler

Types

type Handler

type Handler interface {
	// DecodeRequest turns a HTTP request into a domain-specific request type
	DecodeRequest(*http.Request) (Request, error)

	// A RequestHandler is a monadic definition of a request handler. The inputs
	// are the current state of the world, and a handler-specific request type,
	// and the output is the new state of the world (which may or may not be the
	// same), a handler-specific response type, and/or an error.
	HandleRequest(State, Request) (State, Response, error)
}

A Handler handles requests

type Request

type Request interface {
	FlaggedAsRequest()
}

A Request flags any request type

type Response

type Response interface {
	FlaggedAsResponse()
}

A Response flags any response type

type State

type State struct {
	Library    *speeldoos.Library
	NowPlaying speeldoos.Performance
	RawStream  chunker.Chunker
	MP3Stream  chunker.Chunker
	Buffers    struct {
		Scheduler chunker.Statuser
		MP3Stream chunker.Statuser
	}
}

The State struct represents the current state of the world