package
1.0.1
Repository: https://github.com/apus-run/van.git
Documentation: pkg.go.dev

# Packages

Package mocks is a generated GoMock package.

# Functions

New intializes a new websocket manager with default websocket upgrader.
NewWSUpgrader initialize a new websocket upgarder that upgrades an incoming http request to a websocket connection.
WithCheckOrigin sets the CheckOrigin handler option.
WithCompression enables compression.
WithError sets the Error handler option.
WithHandshakeTimeout sets the HandshakeTimeout option.
WithReadBufferSize sets the ReadBufferSize option.
WithSubprotocols sets the Subprotocols option.
WithWriteBufferSize sets the WriteBufferSize option.

# Constants

TextMessage denotes a text data message.
WSConnectionKey is a key constant that stores the connection id in the request context.

# Variables

ErrorConnection is the connection error that occurs when webscoket connection cannot be established.

# Structs

Connection is a wrapper for gorilla websocket connection.
ConnectionHub stores and provide functionality to work with all active connections with websocket clients.
Manager is a websocket manager that handles the upgrader and manages all active connections through ConnectionHub.
No description provided by the author

# Interfaces

Upgrader interface for upgrading HTTP connections to WebSocket connections.

# Type aliases

Options is a function type that applies a configuration to the concrete Upgrader.
No description provided by the author
WSKey defines the key type for WSConnectionKey.