package
12.2.11
Repository: https://github.com/kataras/iris.git
Documentation: pkg.go.dev

# Functions

GetContext returns the Iris Context from a websocket connection.
Handler returns an Iris handler to be served in a route of an Iris application.
SetDefaultMarshaler changes the default json marshaler.
SetDefaultUnmarshaler changes the default json unmarshaler.
Upgrade upgrades the request and returns a new websocket Conn.

# Variables

DefaultGobwasDialer is a gobwas/ws dialer with all fields set to the default values.
DefaultGobwasUpgrader is a gobwas/ws Upgrader with all fields set to the default values.
DefaultGorillaDialer is a gorilla/websocket dialer with all fields set to the default values.
DefaultGorillaUpgrader is a gorilla/websocket Upgrader with all fields set to the default values.
DefaultIDGenerator returns a universal unique identifier for a new connection.
Dial establishes a new websocket client connection.
EnableDebug enables debug mode for websocket module, for MVC this is done automatically when the app's logger level is set to "debug".
GobwasDialer is a `Dialer` type for the gobwas/ws subprotocol implementation.
GobwasUpgrader is an upgrader type for the gobwas/ws subprotocol implementation.
GorillaDialer is a `Dialer` type for the gorilla/websocket subprotocol implementation.
GorillaUpgrader is an upgrader type for the gorilla/websocket subprotocol implementation.
IsSystemEvent reports whether the "event" is a system event, OnNamespaceConnect, OnNamespaceConnected, OnNamespaceDisconnect, OnRoomJoin, OnRoomJoined, OnRoomLeave and OnRoomLeft.
IsTryingToReconnect reports whether the returning "err" from the `Server#Upgrade` is from a client that was trying to reconnect to the websocket server.
JoinConnHandlers combines two or more ConnHandlers as one.
Marshal marshals the "v" value and returns a Message's Body.
New constructs and returns a new websocket server.
NewNatsStackExchange returns a new nats StackExchange.
NewRedisStackExchange returns a new redis StackExchange.
NewStruct returns the `Struct` Conn Handler based on ptr value.
when event no match.
OnNamespaceConnect is the event name which its callback is fired right before namespace connect, if non-nil error then the remote connection's `Conn.Connect` will fail and send that error text.
OnNamespaceConnected is the event name which its callback is fired after namespace successfully connected.
if allowed to connect then it's allowed to disconnect as well.
OnNativeMessage is fired on incoming native/raw websocket messages.
able to check if allowed to join.
able to broadcast messages to room.
able to broadcast bye-bye messages to room.
if allowed to join to a room, then its allowed to leave from it.
Reply is a special type of custom error which sends a message back to the other side with the exact same incoming Message's Namespace (and Room if specified) except its body which would be the given "body".
WithNatsOptions can be used as the second input argument of `NewNatsStackExchange` to declare a struct-based configuration for the nats server(s).

# Type aliases