server

Documentation

Overview

Package server provides network listeners, e.g. an HTTP (web/REST/JSON) server.

Index

• func CreateJWT(username string, ttl int, secret string) (string, error)
• func GenerateId(size int) string
• func GetSid(req *http.Request) string
• func GetSidHdr(hdr http.Header) (sid string)
• func ParseJWT(tk, secret string) (jwt.Claims, error)
• func Route(ctx *b.Context, spec m.Map, hdlr RqHandler, req *http.Request, ...)
• func SetSid(rsp http.ResponseWriter, sid string)
• func SetSidHdr(hdr http.Header, sid string)
• type RqActionHandler
  • func GetActionHandler(ctx *b.Context, spec m.Map, msg *b.Message) RqActionHandler
• type RqHandler
  • func GetRequestHandler(ctx *b.Context, spec m.Map) (string, RqHandler)
• type ServerState
  • func (st *ServerState) GetSession(sid string) b.Session
• type Session
  • func (s *Session) GetMailbox() b.Mailbox
  • func (s *Session) GetRMailbox(iid string) *mbInfo
  • func (s *Session) ReleaseMailbox(mb *mbInfo)
  • func (s *Session) Send(ctx *b.Context, msg *b.Message)
• type Sessions
  • func (s *Sessions) Get(ctx *b.Context, sid string) *Session

Functions

func CreateJWT

func CreateJWT(username string, ttl int, secret string) (string, error)

func GenerateId

func GenerateId(size int) string

Generate a (hopefully) unique cryptographically secure identifier. The size parameter is specified in 4-byte (= 32-bit) units, so `generateId(2) returns a 64-bit Id. The returned Id is a URL-safe base64-encoded string.

func GetSid

func GetSid(req *http.Request) string

func GetSidHdr

func GetSidHdr(hdr http.Header) (sid string)

func ParseJWT

func ParseJWT(tk, secret string) (jwt.Claims, error)

func Route

func Route(ctx *b.Context, spec m.Map, hdlr RqHandler,
	req *http.Request, rsp http.ResponseWriter)

func SetSid

func SetSid(rsp http.ResponseWriter, sid string)

func SetSidHdr

func SetSidHdr(hdr http.Header, sid string)

Types

type RqActionHandler

type RqActionHandler = func(*b.Context, m.Map, *b.Message,
	*http.Request, http.ResponseWriter, *Session)

func GetActionHandler

func GetActionHandler(ctx *b.Context, spec m.Map, msg *b.Message) RqActionHandler

type RqHandler

type RqHandler = func(*b.Context, m.Map,
	*http.Request, http.ResponseWriter)

func GetRequestHandler

func GetRequestHandler(ctx *b.Context, spec m.Map) (string, RqHandler)

type ServerState

type ServerState struct {
	Server   *http.Server
	Sessions *Sessions
}

func (*ServerState) GetSession

func (st *ServerState) GetSession(sid string) b.Session

type Session

type Session struct {
	SessionId string
	Timestamp int64 // check lifetime/clean-up - when?
	Data      m.Map // metadata, e.g. about user, ...
	// contains filtered or unexported fields
}

func (*Session) GetMailbox

func (s *Session) GetMailbox() b.Mailbox

legacy/deprecated, use `GetRMailbox()` instead

func (*Session) GetRMailbox

func (s *Session) GetRMailbox(iid string) *mbInfo

Return a mailbox for this request. Make sure to release unused mailboxes when finished using: `defer s.ReleaseMailbox(mb, <del>)`

func (*Session) ReleaseMailbox

func (s *Session) ReleaseMailbox(mb *mbInfo)

func (*Session) Send

func (s *Session) Send(ctx *b.Context, msg *b.Message)

type Sessions

type Sessions struct {
	// contains filtered or unexported fields
}

func (*Sessions) Get

func (s *Sessions) Get(ctx *b.Context, sid string) *Session