websocket

Documentation

Index

• Constants
• type Emitter
  • func NewEmitter() *Emitter
  • func (e *Emitter) Address() string
  • func (e *Emitter) Close() error
  • func (e *Emitter) Emit(entry *entry.Entry)
  • func (e *Emitter) Init() error
• type Message

Constants

const DefaultPort = 9106

DefaultPort is the default port for the WebSocket server

Types

type Emitter

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

func NewEmitter

func NewEmitter() *Emitter

NewEmitter creates a new WebSocket emitter

func (*Emitter) Address

func (e *Emitter) Address() string

Address returns server address (for testing)

func (*Emitter) Close

func (e *Emitter) Close() error

Close shuts down the WebSocket server

func (*Emitter) Emit

func (e *Emitter) Emit(entry *entry.Entry)

Emit sends log entry to all connected clients

func (*Emitter) Init

func (e *Emitter) Init() error

Init starts WebSocket server on port 9106 or the next available port

type Message

type Message struct {
	ID   int64       `json:"id"` // Combination of timestamp and sequence number (see Emitter.sequence for details)
	Body interface{} `json:"body"`
}

Emitter implements WebSocket server that broadcasts log entries to connected clients Message represents a WebSocket message with ID