wsconfig

Documentation

Index

• Constants
• func GenerateConfigFromPrefix(prefix config.Prefix) *wsclient.WSConfig
• func InitPrefix(prefix config.KeySet)

Constants

const (
	// WSSpecificConfPrefix is the sub-section of the http config options that contains websocket specific config
	WSSpecificConfPrefix = "ws"
	// WSConfigKeyWriteBufferSize is the write buffer size
	WSConfigKeyWriteBufferSize = "ws.writeBufferSize"
	// WSConfigKeyReadBufferSize is the read buffer size
	WSConfigKeyReadBufferSize = "ws.readBufferSize"
	// WSConfigKeyInitialConnectAttempts sets how many times the websocket should attempt to connect on startup, before failing (after initial connection, retry is indefinite)
	WSConfigKeyInitialConnectAttempts = "ws.initialConnectAttempts"
	// WSConfigKeyPath if set will define the path to connect to - allows sharing of the same URL between HTTP and WebSocket connection info
	WSConfigKeyPath = "ws.path"
)

Functions

func GenerateConfigFromPrefix

func GenerateConfigFromPrefix(prefix config.Prefix) *wsclient.WSConfig

func InitPrefix

func InitPrefix(prefix config.KeySet)

InitPrefix ensures the prefix is initialized for HTTP too, as WS and HTTP can share the same tree of configuration (and all the HTTP options apply to the initial upgrade)