websocket

Documentation

Index

• type Multiplexor
  • func NewMultiplexor(log logging.SimpleLogging, keyGenerator PartitionKeyGenerator, ...) *Multiplexor
  • func (m *Multiplexor) Handle(w http.ResponseWriter, r *http.Request) error
• type PartitionKeyGenerator
• type PartitionRegistry
• type Writer
  • func NewWriter(log logging.SimpleLogging, checkOrigin bool) *Writer
  • func (w *Writer) Write(rw http.ResponseWriter, r *http.Request, input chan string) error

Types

type Multiplexor

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

Multiplexor is responsible for handling the data transfer between the storage layer and the registry. Note this is still a WIP as right now the registry is assumed to handle everything.

func NewMultiplexor

func NewMultiplexor(log logging.SimpleLogging, keyGenerator PartitionKeyGenerator, registry PartitionRegistry, checkOrigin bool) *Multiplexor

func (*Multiplexor) Handle

func (m *Multiplexor) Handle(w http.ResponseWriter, r *http.Request) error

Handle should be called for a given websocket request. It blocks while writing to the websocket until the buffer is closed.

type PartitionKeyGenerator

type PartitionKeyGenerator interface {
	Generate(r *http.Request) (string, error)
}

PartitionKeyGenerator generates partition keys for the multiplexor

type PartitionRegistry

type PartitionRegistry interface {
	Register(key string, buffer chan string)
	Deregister(key string, buffer chan string)
	IsKeyExists(key string) bool
}

PartitionRegistry is the registry holding each partition and is responsible for registering/deregistering new buffers

type Writer

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

func NewWriter

func NewWriter(log logging.SimpleLogging, checkOrigin bool) *Writer

func (*Writer) Write

func (w *Writer) Write(rw http.ResponseWriter, r *http.Request, input chan string) error