starlight

README

Starlight

Full-duplex real-time web protocol

Documentation

Index

• Constants
• Variables
• type Protocol
  • func (i Protocol) String() string
• type Starlight
  • func NewStarlight(options ...StarlightOption) *Starlight
  • func (g *Starlight) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type StarlightConfig
• type StarlightOption
  • func WithAllowLongPoll(allow bool) StarlightOption
  • func WithAllowPoll(allow bool) StarlightOption
  • func WithAllowSSE(allow bool) StarlightOption
  • func WithAllowWebsocket(allow bool) StarlightOption
  • func WithDefaultProtocol(protocol Protocol) StarlightOption
  • func WithNotFoundHandler(handler func(w http.ResponseWriter, r *http.Request)) StarlightOption

Constants

const PROTOCOL_VERSION = 1

Variables

var NotFoundHandler = http.HandlerFunc(handleNotFound)

Types

type Protocol

type Protocol uint16

const (
	PROTOCOL_poll01 Protocol = 10 // poll01
	PROTOCOL_lpll01 Protocol = 11 // lpll01
	PROTOCOL_hsse01 Protocol = 12 // hsse01
	PROTOCOL_webs01 Protocol = 13 // webs01
)

func (Protocol) String

func (i Protocol) String() string

type Starlight

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

func NewStarlight

func NewStarlight(options ...StarlightOption) *Starlight

func (*Starlight) ServeHTTP

func (g *Starlight) ServeHTTP(w http.ResponseWriter, r *http.Request)

type StarlightConfig

type StarlightConfig struct {
	AllowPoll      bool // poll01
	AllowLongPoll  bool // lpll01
	AllowSSE       bool // hsse01
	AllowWebsocket bool // webs01

	SessionTimeout       time.Duration
	LongPollTimeout      time.Duration
	HTTPStreamingTimeout time.Duration

	BasePath        string
	DefaultProtocol Protocol

	NotFoundHandler func(w http.ResponseWriter, r *http.Request)
}

type StarlightOption

type StarlightOption func(*StarlightConfig)

func WithAllowLongPoll

func WithAllowLongPoll(allow bool) StarlightOption

func WithAllowPoll

func WithAllowPoll(allow bool) StarlightOption

func WithAllowSSE

func WithAllowSSE(allow bool) StarlightOption

func WithAllowWebsocket

func WithAllowWebsocket(allow bool) StarlightOption

func WithDefaultProtocol

func WithDefaultProtocol(protocol Protocol) StarlightOption

func WithNotFoundHandler

func WithNotFoundHandler(handler func(w http.ResponseWriter, r *http.Request)) StarlightOption