http

package

v1.14.4 Latest Latest Go to latest Published: Nov 14, 2023 License: MIT Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/CallumKerson/Athenaeum

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetCachingMiddleware(cacheStore CacheStore) func(http.Handler) http.Handler
func GetLoggingMiddleware(logger loggerrific.Logger) func(http.Handler) http.Handler
func SendJSON(writer http.ResponseWriter, status int, p any)
func SendJSONError(w http.ResponseWriter, status int, err error)
func Serve(handler http.Handler, port int, logger loggerrific.Logger) error
func SevereRateLimitMiddleware(next http.Handler) http.Handler
func TimeoutMiddleware(next http.Handler) http.Handler
type AudiobooksPodcastService
type CacheStore
type Handler
- func NewHandler(podcastService AudiobooksPodcastService, mediaRoot string, ...) *Handler
type HandlerOption
type Middlewares
type Payload

Constants ¶

View Source

const (
	StaticPath      = "/static"
	PodcastPath     = "/podcast"
	MediaPath       = "/media"
	PodcastFeedName = "feed.rss"
)

View Source

const (
	ContentTypeHeader  = "Content-Type"
	ContentTypeXML     = "application/xml; charset=utf-8"
	ContentTypeTextXML = "text/xml; charset=utf-8"
	ContentTypeJSON    = "application/json; charset=utf-8"
	ContentTypeHTML    = "text/html"
)

Variables ¶

This section is empty.

Functions ¶

func GetCachingMiddleware ¶ added in v1.13.2

func GetCachingMiddleware(cacheStore CacheStore) func(http.Handler) http.Handler

func GetLoggingMiddleware ¶ added in v1.13.2

func GetLoggingMiddleware(logger loggerrific.Logger) func(http.Handler) http.Handler

func SendJSON ¶

func SendJSON(writer http.ResponseWriter, status int, p any)

func SendJSONError ¶

func SendJSONError(w http.ResponseWriter, status int, err error)

func Serve ¶

func Serve(handler http.Handler, port int, logger loggerrific.Logger) error

func SevereRateLimitMiddleware ¶

func SevereRateLimitMiddleware(next http.Handler) http.Handler

func TimeoutMiddleware ¶

func TimeoutMiddleware(next http.Handler) http.Handler

Types ¶

type AudiobooksPodcastService ¶

type AudiobooksPodcastService interface {
	WriteAllAudiobooksFeed(context.Context, io.Writer) error
	WriteGenreAudiobookFeed(context.Context, audiobooks.Genre, io.Writer) error
	WriteAuthorAudiobookFeed(context.Context, string, io.Writer) (bool, error)
	WriteNarratorAudiobookFeed(context.Context, string, io.Writer) (bool, error)
	WriteTagAudiobookFeed(context.Context, string, io.Writer) (bool, error)
	UpdateFeeds(context.Context) error
	IsReady(ctx context.Context) bool
}

type CacheStore ¶ added in v1.11.0

type CacheStore interface {
	Get(key uint64) ([]byte, bool)
	Set(key uint64, content []byte, expiration time.Time)
	Release(key uint64)
	ReleaseAll()
	GetTTL() time.Duration
}

type Handler ¶

type Handler struct {
	*chi.Mux
	PodcastService AudiobooksPodcastService

	CacheStore CacheStore
	Log        loggerrific.Logger
	// contains filtered or unexported fields
}

func NewHandler ¶

func NewHandler(podcastService AudiobooksPodcastService, mediaRoot string, opts ...HandlerOption) *Handler

type HandlerOption ¶

type HandlerOption func(h *Handler)

func WithCacheStore ¶ added in v1.13.2

func WithCacheStore(cacheStore CacheStore) HandlerOption

func WithLogger ¶ added in v1.13.2

func WithLogger(logger loggerrific.Logger) HandlerOption

func WithVersion ¶

func WithVersion(version string) HandlerOption

type Middlewares ¶

type Middlewares struct {
	loggerrific.Logger
	CacheStore
}

type Payload ¶

type Payload map[string]any

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL