io

Documentation

Overview

Package io is the websocket package. This currently runs with the api but might end up moving to it's own api depending on performance and/or community preference.

Index

• type Factory
  • func New() *Factory
  • func (f *Factory) Register(k8Client k8sv1.Clienter, w http.ResponseWriter, r *http.Request)
  • func (f *Factory) Run()
• type SocketFactory

Types

type Factory

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

Factory maintains the set of active clients

func New

func New() *Factory

New initializes the socket factory

func (*Factory) Register

func (f *Factory) Register(k8Client k8sv1.Clienter, w http.ResponseWriter, r *http.Request)

Register handles websocket requests from the peer.

func (*Factory) Run

func (f *Factory) Run()

Run starts the socket factory to handle client connections This function is available via NewFactory since Run() should only be called when the api starts.

type SocketFactory

type SocketFactory interface {
	// Run starts the websocket
	Run()
	// Register registers the new connection with the factory
	Register(k8Client k8sv1.Clienter, w http.ResponseWriter, r *http.Request)
}

SocketFactory interfaces Factory to run websockets