websocket

Documentation

Index

• type Command
• type Event
• type Manager
  • func New() (*Manager, error)
  • func (m *Manager) Handle(session sockjs.Session)
  • func (m *Manager) Start()
  • func (m *Manager) Stop()
• type Protocol
• type Publisher
  • func NewPublisher() (*Publisher, error)
  • func (p *Publisher) EmitEvent(ctx context.Context, e Event) error
• type Subscriber
  • func NewSubscriber(ec chan *Event) (*Subscriber, error)
  • func (s *Subscriber) Start()
  • func (s *Subscriber) Stop()

Types

type Command

type Command string

const (
	Attach Command = "__attach"
	Detach Command = "__detach"
)

type Event

type Event struct {
	Scope   apistructs.Scope `json:"scope"`
	Type    string           `json:"type"`
	Payload interface{}      `json:"payload"`
}

type Manager

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

func New

func New() (*Manager, error)

func (*Manager) Handle

func (m *Manager) Handle(session sockjs.Session)

func (*Manager) Start

func (m *Manager) Start()

func (*Manager) Stop

func (m *Manager) Stop()

type Protocol

type Protocol struct {
	Scope   apistructs.Scope `json:"scope"`
	Command Command          `json:"command"`
}

type Publisher

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

func NewPublisher

func NewPublisher() (*Publisher, error)

func (*Publisher) EmitEvent

func (p *Publisher) EmitEvent(ctx context.Context, e Event) error

type Subscriber

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

func NewSubscriber

func NewSubscriber(ec chan *Event) (*Subscriber, error)

func (*Subscriber) Start

func (s *Subscriber) Start()

func (*Subscriber) Stop

func (s *Subscriber) Stop()