live

Feb 23, 2023

Changes in this version

type BaseEngine

+ func (e *BaseEngine) Unmount() UnmountHandler

type BaseHandler

+ func (h *BaseHandler) HandleUnmount(f UnmountHandler)

type Engine

+ Unmount func() UnmountHandler

type Handler

+ HandleUnmount func(handler UnmountHandler)

+ type UnmountHandler func(c Socket) error

Jul 17, 2022

Changes in this version

type EngineConfig

+ func WithWebsocketAcceptOptions(options *websocket.AcceptOptions) EngineConfig

Apr 6, 2022

Changes in this version

+ var ErrUploadMalformed = errors.New("upload malformed")

+ var ErrUploadNotAccepted = errors.New("upload not accepted")

+ var ErrUploadNotFound = errors.New("uploads not found")

+ var ErrUploadTooLarge = errors.New("upload too large")

+ var ErrUploadTooManyFiles = errors.New("upload too many files")

+ func ConsumeUploads(s Socket, name string, ch ConsumeHandler) []error

+ func ValidateUploads(s Socket, p Params)

type BaseEngine

+ IgnoreFaviconRequest bool

+ MaxUploadSize int64

+ UploadStagingLocation string

+ func (e *BaseEngine) GetSocket(session Session) (Socket, error)

type BaseSocket

+ func (s *BaseSocket) AllowUploads(config *UploadConfig)

+ func (s *BaseSocket) AssignUpload(config string, upload *Upload)

+ func (s *BaseSocket) ClearUpload(config string, upload *Upload)

+ func (s *BaseSocket) ClearUploads()

+ func (s *BaseSocket) UploadConfigs() []*UploadConfig

+ func (s *BaseSocket) Uploads() UploadContext

+ type ConsumeHandler func(u *Upload) error

type Engine

+ GetSocket func(session Session) (Socket, error)

+ type EngineConfig func(e Engine) error

+ func WithMaxUploadSize(size int64) EngineConfig

+ func WithUploadStagingLocation(stagingLocation string) EngineConfig

+ type RenderContext struct

+ Assigns interface{}

+ Socket Socket

+ Uploads UploadContext

type Socket

+ AllowUploads func(config *UploadConfig)

+ AssignUpload func(config string, upload *Upload)

+ ClearUpload func(config string, upload *Upload)

+ ClearUploads func()

+ UploadConfigs func() []*UploadConfig

+ Uploads func() UploadContext

+ type Upload struct

+ Errors []error

+ LastModified string

+ Name string

+ Progress float32

+ Size int64

+ Type string

+ func (u Upload) File() (*os.File, error)

+ type UploadConfig struct

+ Accept []string

+ MaxFiles int

+ MaxSize int64

+ Name string

+ type UploadContext map[string][]*Upload

+ func (u UploadContext) HasErrors() bool

+ type UploadError struct

+ func (u *UploadError) Error() string

+ func (u *UploadError) Unwrap() error

+ type UploadProgress struct

+ Engine Engine

+ Socket Socket

+ Upload *Upload

+ func (u *UploadProgress) Write(p []byte) (n int, err error)

Jan 4, 2022

Changes in this version

type Event

+ SelfData interface{}

+ type SelfHandler func(context.Context, Socket, interface{}) (interface{}, error)

Jan 3, 2022

Changes in this version

+ var ErrNotImplemented = errors.New("not implemented")

+ func RenderSocket(ctx context.Context, e Engine, s Socket) (*html.Node, error)

+ func Request(ctx context.Context) *http.Request

+ func Writer(ctx context.Context) http.ResponseWriter

+ type BaseEngine struct

+ func NewBaseEngine(h Handler) *BaseEngine

+ func (e *BaseEngine) AddSocket(sock Socket)

+ func (e *BaseEngine) Broadcast(event string, data interface{}) error

+ func (e *BaseEngine) CallEvent(ctx context.Context, t string, sock Socket, msg Event) error

+ func (e *BaseEngine) CallParams(ctx context.Context, sock Socket, msg Event) error

+ func (e *BaseEngine) DeleteSocket(sock Socket)

+ func (e *BaseEngine) Error() ErrorHandler

+ func (e *BaseEngine) HandleBroadcast(f BroadcastHandler)

+ func (e *BaseEngine) Handler(hand Handler)

+ func (e *BaseEngine) Mount() MountHandler

+ func (e *BaseEngine) Params() []EventHandler

+ func (e *BaseEngine) Render() RenderHandler

+ type BaseHandler struct

+ func (h *BaseHandler) HandleError(f ErrorHandler)

+ func (h *BaseHandler) HandleEvent(t string, handler EventHandler)

+ func (h *BaseHandler) HandleMount(f MountHandler)

+ func (h *BaseHandler) HandleParams(handler EventHandler)

+ func (h *BaseHandler) HandleRender(f RenderHandler)

+ func (h *BaseHandler) HandleSelf(t string, handler EventHandler)

+ type BaseSocket struct

+ func NewBaseSocket(s Session, e Engine, connected bool) *BaseSocket

+ func (s *BaseSocket) Assign(data interface{})

+ func (s *BaseSocket) Assigns() interface{}

+ func (s *BaseSocket) Broadcast(event string, data interface{}) error

+ func (s *BaseSocket) Connected() bool

+ func (s *BaseSocket) ID() SocketID

+ func (s *BaseSocket) LatestRender() *html.Node

+ func (s *BaseSocket) Messages() chan Event

+ func (s *BaseSocket) PatchURL(values url.Values)

+ func (s *BaseSocket) Redirect(u *url.URL)

+ func (s *BaseSocket) Self(ctx context.Context, event string, data interface{}) error

+ func (s *BaseSocket) Send(event string, data interface{}, options ...EventConfig) error

+ func (s *BaseSocket) Session() Session

+ func (s *BaseSocket) UpdateRender(render *html.Node)

+ type BroadcastHandler func(ctx context.Context, e Engine, msg Event)

+ type Engine interface

+ AddSocket func(sock Socket)

+ Broadcast func(event string, data interface{}) error

+ CallEvent func(ctx context.Context, t string, sock Socket, msg Event) error

+ CallParams func(ctx context.Context, sock Socket, msg Event) error

+ DeleteSocket func(sock Socket)

+ Error func() ErrorHandler

+ HandleBroadcast func(handler BroadcastHandler)

+ Handler func(h Handler)

+ Mount func() MountHandler

+ Params func() []EventHandler

+ Render func() RenderHandler

+ type ErrorEvent struct

+ Err string

+ Source Event

type Handler

+ HandleError func(handler ErrorHandler)

+ HandleMount func(handler MountHandler)

+ HandleRender func(handler RenderHandler)

+ type HttpEngine struct

+ func NewHttpHandler(store HttpSessionStore, handler Handler) *HttpEngine

+ func (h *HttpEngine) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HttpSessionStore interface

+ Clear func(http.ResponseWriter, *http.Request) error

+ Get func(*http.Request) (Session, error)

+ Save func(http.ResponseWriter, *http.Request, Session) error

+ type HttpSocket struct

+ func NewHttpSocket(s Session, e Engine, connected bool) *HttpSocket

type Socket

+ ID func() SocketID

+ LatestRender func() *html.Node

+ Messages func() chan Event

+ UpdateRender func(render *html.Node)

+ type SocketID string

Dec 23, 2021

Changes in this version

type CookieStore

+ func (c CookieStore) Clear(w http.ResponseWriter, r *http.Request) error

type SessionStore

+ Clear func(http.ResponseWriter, *http.Request) error

Nov 9, 2021

Changes in this version

+ func SessionID(session Session) string

Nov 2, 2021

Changes in this version

type Patch

+ Anchor string

Apr 9, 2021

Changes in this version

+ type EventConfig func(e *Event) error

+ func WithID(ID int) EventConfig

+ type LocalTransport struct

+ func NewLocalTransport() *LocalTransport

+ func (l *LocalTransport) Listen(ctx context.Context, p *PubSub) error

+ func (l *LocalTransport) Publish(ctx context.Context, topic string, msg Event) error

+ type Params map[string]interface

+ func (p Params) Checkbox(key string) bool

+ func (p Params) Float32(key string) float32

+ func (p Params) Int(key string) int

+ func (p Params) String(key string) string

+ func NewParamsFromRequest(r *http.Request) Params

+ type PubSub struct

+ func NewPubSub(ctx context.Context, t PubSubTransport) *PubSub

+ func (p *PubSub) Publish(ctx context.Context, topic string, msg Event) error

+ func (p *PubSub) Recieve(topic string, msg Event)

+ func (p *PubSub) Subscribe(topic string, h *Handler)

+ type PubSubTransport interface

+ Listen func(ctx context.Context, p *PubSub) error

+ Publish func(ctx context.Context, topic string, msg Event) error

+ type TransportMessage struct

+ Msg Event

+ Topic string

Feb 14, 2021

Changes in this version

type Socket

+ func (s *Socket) Broadcast(msg Event)

+ func (s *Socket) Connected() bool

+ func (s *Socket) Self(ctx context.Context, msg Event)

Feb 13, 2021

Changes in this version

+ const EventParams

+ const EventRedirect

+ func ParamsFromRequest(r *http.Request) map[string]interface

type Handler

+ func (h *Handler) HandleParams(handler EventHandler)

type Socket

+ func (s *Socket) PatchURL(values url.Values)

+ func (s *Socket) Redirect(u *url.URL)

Feb 11, 2021

Changes in this version

type Socket

+ func (s *Socket) Context() context.Context

Feb 11, 2021

Changes in this version

+ const LiveRendered

Jan 30, 2021

Changes in this version

type Patch

+ func (p Patch) String() string

Jan 28, 2021

Changes in this version

+ const EventConnect

Jan 16, 2021

Changes in this version

+ var ErrNoRenderer = errors.New("no renderer has been set on the handler")

type HandlerConfig

+ func WithTemplateRenderer(t *template.Template) HandlerConfig

Jan 5, 2021

Changes in this version

+ const EventAck

type Event

+ ID int

Jan 4, 2021

Changes in this version

+ const EventHello

type CookieStore

+ Store *sessions.CookieStore

+ type ErrorHandler func(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)

type Handler

+ Error ErrorHandler

Jan 2, 2021

Changes in this version

+ func ParamCheckbox(params map[string]interface{}, name string) bool

Jan 1, 2021

Changes in this version

+ type CookieStore struct

+ func NewCookieStore(sessionName string, keyPairs ...[]byte) *CookieStore

+ func (c CookieStore) Get(r *http.Request) (Session, error)

+ func (c CookieStore) Save(w http.ResponseWriter, r *http.Request, session Session) error

+ type SessionStore interface

+ Get func(*http.Request) (Session, error)

+ Save func(http.ResponseWriter, *http.Request, Session) error

Dec 31, 2020

Changes in this version

+ const EventError

+ const EventPatch

+ const MaxMessageBufferSize

+ var ErrMessageMalformed = errors.New("message malformed")

+ var ErrNoEventHandler = errors.New("view missing event handler")

+ var ErrNoSocket = errors.New("no socket")

+ func NewID() string

+ func ParamFloat32(params map[string]interface{}, key string) float32

+ func ParamInt(params map[string]interface{}, key string) int

+ func ParamString(params map[string]interface{}, key string) string

+ func StartHandler(h *Handler)

+ type Event struct

+ Data interface{}

+ T string

+ func (e Event) Params() (map[string]interface{}, error)

+ type EventHandler func(*Socket, map[string]interface{}) (interface{}, error)

+ type Handler struct

+ Mount MountHandler

+ Render RenderHandler

+ func NewHandler(t *template.Template, sessionKey string, store sessions.Store, ...) (*Handler, error)

+ func (h *Handler) Broadcast(msg Event)

+ func (h *Handler) HandleEvent(t string, handler EventHandler)

+ func (h *Handler) HandleSelf(t string, handler EventHandler)

+ func (h *Handler) Self(sock *Socket, msg Event)

+ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HandlerConfig func(h *Handler) error

+ func WithRootTemplate(rootTemplate string) HandlerConfig

+ type HandlerEvent struct

+ Msg Event

+ S *Socket

+ type Javascript struct

+ func (j Javascript) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type JavascriptMap struct

+ func (j JavascriptMap) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type MountHandler func(ctx context.Context, h *Handler, r *http.Request, c *Socket, connected bool) (interface{}, error)

+ type Patch struct

+ Action PatchAction

+ HTML string

+ Path []int

+ func Diff(current, proposed *html.Node) ([]Patch, error)

+ type PatchAction uint32

+ const Append

+ const Insert

+ const Noop

+ const Prepend

+ const Replace

+ type RenderHandler func(ctx context.Context, t *template.Template, data interface{}) (io.Reader, error)

+ type Session struct

+ ID string

+ func NewSession() Session

+ type Socket struct

+ Session Session

+ func NewSocket(s Session) *Socket

+ func (s *Socket) Assign(data interface{})

+ func (s *Socket) Assigns() interface{}

+ func (s *Socket) Send(msg Event)

+ type ValueKey string

+ const SessionKey