pslive

package

v0.3.10 Latest Latest Go to latest Published: Apr 19, 2023 License: Apache-2.0 Imports: 28 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/sargassum-world/pslive

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pslive provides the Planktoscope Live server.

Index ¶

func NewCSRFErrorHandler(tr godest.TemplateRenderer, l echo.Logger, ss *session.Store) http.HandlerFunc
func NewHTTPErrorHandler(tr godest.TemplateRenderer, ss *session.Store) echo.HTTPErrorHandler
func NewRegoModules() []opa.Module
func RegoDeps() []opa.Module
type ErrorData
type Server
- func NewServer(config conf.Config, workers []Worker, logger godest.Logger) (s *Server, err error)
type Worker
- func DefaultWorkers() []Worker

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewCSRFErrorHandler ¶

func NewCSRFErrorHandler(
	tr godest.TemplateRenderer, l echo.Logger, ss *session.Store,
) http.HandlerFunc

func NewHTTPErrorHandler ¶

func NewHTTPErrorHandler(tr godest.TemplateRenderer, ss *session.Store) echo.HTTPErrorHandler

func NewRegoModules ¶ added in v0.1.15

func NewRegoModules() []opa.Module

func RegoDeps ¶ added in v0.2.0

func RegoDeps() []opa.Module

Types ¶

type ErrorData ¶

type ErrorData struct {
	Code     int
	Error    httperr.DescriptiveError
	Messages []string
}

type Server ¶

type Server struct {
	DBEmbeds database.Embeds
	Globals  *client.Globals
	Embeds   godest.Embeds
	Inlines  godest.Inlines
	Renderer godest.TemplateRenderer
	Handlers *routes.Handlers
	Workers  []Worker
}

func NewServer ¶

func NewServer(config conf.Config, workers []Worker, logger godest.Logger) (s *Server, err error)

func (*Server) Close ¶ added in v0.1.7

func (s *Server) Close(e *echo.Echo) error

func (*Server) Register ¶

func (s *Server) Register(e *echo.Echo) error

func (*Server) Run ¶ added in v0.1.7

func (s *Server) Run(e *echo.Echo) error

func (*Server) Shutdown ¶ added in v0.1.7

func (s *Server) Shutdown(ctx context.Context, e *echo.Echo) (err error)

type Worker ¶ added in v0.3.6

type Worker func(ctx context.Context, s *Server) error

func DefaultWorkers ¶ added in v0.3.6

func DefaultWorkers() []Worker

Source Files ¶

View all Source files

Directories ¶

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

Path	Synopsis
auth Package auth provides application-level standardization for authentication	Package auth provides application-level standardization for authentication
client Package client contains client code for external APIs	Package client contains client code for external APIs
conf Package conf supports environment variable-based application configuration	Package conf supports environment variable-based application configuration
handling Package handling provides reusable handlers.	Package handling provides reusable handlers.
routes Package routes contains the route handlers for the Planktoscope Live server.	Package routes contains the route handlers for the Planktoscope Live server.
assets Package assets contains the route handlers for assets which are static for the server	Package assets contains the route handlers for assets which are static for the server
auth Package auth contains the route handlers related to authentication and authorization.	Package auth contains the route handlers related to authentication and authorization.
cable Package cable contains the route handlers serving Action Cables over WebSockets by implementing the Action Cable Protocol (https://docs.anycable.io/misc/action_cable_protocol) on the server.	Package cable contains the route handlers serving Action Cables over WebSockets by implementing the Action Cable Protocol (https://docs.anycable.io/misc/action_cable_protocol) on the server.
home Package home contains the route handlers related to the app's home screen.	Package home contains the route handlers related to the app's home screen.
instruments Package instruments contains the route handlers related to imaging instruments.	Package instruments contains the route handlers related to imaging instruments.
privatechat Package privatechat contains the route handlers related to private chats.	Package privatechat contains the route handlers related to private chats.
users Package users contains the route handlers related to users.	Package users contains the route handlers related to users.
videostreams Package videostreams contains the route handlers related to streaming video delivery	Package videostreams contains the route handlers related to streaming video delivery
tmplfunc Package tmplfunc contains extension functions for templates	Package tmplfunc contains extension functions for templates
workers Package workers provides functionality which runs independently of request servicing.	Package workers provides functionality which runs independently of request servicing.