mirror of
https://github.com/kataras/iris.git
synced 2025-12-22 04:17:03 +00:00
Add the new websocket package (which is just a helper for kataras/neffos) and an example for go server, client, browser client and nodejs client. Add a .fossa.yml and the generated NOTICE file for 3rd-party libs. Update go.mod, go.sum. Update the vendor folder for pongo2 to its latest master as well
Former-commit-id: 89c05079415977d65e7328a1eb8a1c602d76f78a
This commit is contained in:
Gerasimos (Makis) Maropoulos
@@ -1,69 +1,107 @@
|
||||
/*Package websocket provides rich websocket support for the iris web framework.
|
||||
|
||||
Source code and other details for the project are available at GitHub:
|
||||
|
||||
https://github.com/kataras/iris/tree/master/websocket
|
||||
|
||||
Example code:
|
||||
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/kataras/iris"
|
||||
"github.com/kataras/iris/context"
|
||||
|
||||
"github.com/kataras/iris/websocket"
|
||||
)
|
||||
|
||||
func main() {
|
||||
app := iris.New()
|
||||
|
||||
app.Get("/", func(ctx context.Context) {
|
||||
ctx.ServeFile("websockets.html", false)
|
||||
})
|
||||
|
||||
setupWebsocket(app)
|
||||
|
||||
// x2
|
||||
// http://localhost:8080
|
||||
// http://localhost:8080
|
||||
// write something, press submit, see the result.
|
||||
app.Run(iris.Addr(":8080"))
|
||||
}
|
||||
|
||||
func setupWebsocket(app *iris.Application) {
|
||||
// create our echo websocket server
|
||||
ws := websocket.New(websocket.Config{
|
||||
ReadBufferSize: 1024,
|
||||
WriteBufferSize: 1024,
|
||||
})
|
||||
ws.OnConnection(handleConnection)
|
||||
|
||||
// register the server's endpoint.
|
||||
// see the inline javascript code in the websockets.html,
|
||||
// this endpoint is used to connect to the server.
|
||||
app.Get("/echo", ws.Handler())
|
||||
|
||||
// serve the javascript builtin client-side library,
|
||||
// see websockets.html script tags, this path is used.
|
||||
app.Any("/iris-ws.js", func(ctx context.Context) {
|
||||
ctx.Write(websocket.ClientSource)
|
||||
})
|
||||
}
|
||||
|
||||
func handleConnection(c websocket.Connection) {
|
||||
// Read events from browser
|
||||
c.On("chat", func(msg string) {
|
||||
// Print the message to the console
|
||||
fmt.Printf("%s sent: %s\n", c.Context().RemoteAddr(), msg)
|
||||
// Write message back to the client message owner:
|
||||
// c.Emit("chat", msg)
|
||||
c.To(websocket.Broadcast).Emit("chat", msg)
|
||||
})
|
||||
}
|
||||
|
||||
*/
|
||||
package websocket
|
||||
|
||||
import (
|
||||
"github.com/kataras/iris/context"
|
||||
|
||||
"github.com/kataras/neffos"
|
||||
"github.com/kataras/neffos/gobwas"
|
||||
"github.com/kataras/neffos/gorilla"
|
||||
)
|
||||
|
||||
var (
|
||||
// GorillaUpgrader is an upgrader type for the gorilla/websocket subprotocol implementation.
|
||||
// Should be used on `New` to construct the websocket server.
|
||||
GorillaUpgrader = gorilla.Upgrader
|
||||
// GobwasUpgrader is an upgrader type for the gobwas/ws subprotocol implementation.
|
||||
// Should be used on `New` to construct the websocket server.
|
||||
GobwasUpgrader = gobwas.Upgrader
|
||||
// DefaultGorillaUpgrader is a gorilla/websocket Upgrader with all fields set to the default values.
|
||||
DefaultGorillaUpgrader = gorilla.DefaultUpgrader
|
||||
// DefaultGobwasUpgrader is a gobwas/ws Upgrader with all fields set to the default values.
|
||||
DefaultGobwasUpgrader = gobwas.DefaultUpgrader
|
||||
// New constructs and returns a new websocket server.
|
||||
// Listens to incoming connections automatically, no further action is required from the caller.
|
||||
// The second parameter is the "connHandler", it can be
|
||||
// filled as `Namespaces`, `Events` or `WithTimeout`, same namespaces and events can be used on the client-side as well,
|
||||
// Use the `Conn#IsClient` on any event callback to determinate if it's a client-side connection or a server-side one.
|
||||
//
|
||||
// See examples for more.
|
||||
New = neffos.New
|
||||
|
||||
// GorillaDialer is a gorilla/websocket dialer with all fields set to the default values.
|
||||
GorillaDialer = gorilla.DefaultDialer
|
||||
// GobwasDialer is a gobwas/ws dialer with all fields set to the default values.
|
||||
GobwasDialer = gobwas.DefaultDialer
|
||||
// Dial establishes a new websocket client connection.
|
||||
// Context "ctx" is used for handshake timeout.
|
||||
// Dialer "dial" can be either `GorillaDialer` or `GobwasDialer`,
|
||||
// custom dialers can be used as well when complete the `Socket` and `Dialer` interfaces for valid client.
|
||||
// URL "url" is the endpoint of the websocket server, i.e "ws://localhost:8080/echo".
|
||||
// The last parameter, and the most important one is the "connHandler", it can be
|
||||
// filled as `Namespaces`, `Events` or `WithTimeout`, same namespaces and events can be used on the server-side as well.
|
||||
//
|
||||
// See examples for more.
|
||||
Dial = neffos.Dial
|
||||
|
||||
// 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.
|
||||
// Connection is not ready to emit data to the namespace.
|
||||
OnNamespaceConnect = neffos.OnNamespaceConnect
|
||||
// OnNamespaceConnected is the event name which its callback is fired after namespace successfully connected.
|
||||
// Connection is ready to emit data back to the namespace.
|
||||
OnNamespaceConnected = neffos.OnNamespaceConnected
|
||||
// OnNamespaceDisconnect is the event name which its callback is fired when
|
||||
// remote namespace disconnection or local namespace disconnection is happening.
|
||||
// For server-side connections the reply matters, so if error returned then the client-side cannot disconnect yet,
|
||||
// for client-side the return value does not matter.
|
||||
OnNamespaceDisconnect = neffos.OnNamespaceDisconnect // if allowed to connect then it's allowed to disconnect as well.
|
||||
// OnRoomJoin is the event name which its callback is fired right before room join.
|
||||
OnRoomJoin = neffos.OnRoomJoin // able to check if allowed to join.
|
||||
// OnRoomJoined is the event name which its callback is fired after the connection has successfully joined to a room.
|
||||
OnRoomJoined = neffos.OnRoomJoined // able to broadcast messages to room.
|
||||
// OnRoomLeave is the event name which its callback is fired right before room leave.
|
||||
OnRoomLeave = neffos.OnRoomLeave // able to broadcast bye-bye messages to room.
|
||||
// OnRoomLeft is the event name which its callback is fired after the connection has successfully left from a room.
|
||||
OnRoomLeft = neffos.OnRoomLeft // if allowed to join to a room, then its allowed to leave from it.
|
||||
// OnAnyEvent is the event name which its callback is fired when incoming message's event is not declared to the ConnHandler(`Events` or `Namespaces`).
|
||||
OnAnyEvent = neffos.OnAnyEvent // when event no match.
|
||||
// OnNativeMessage is fired on incoming native/raw websocket messages.
|
||||
// If this event defined then an incoming message can pass the check (it's an invalid message format)
|
||||
// with just the Message's Body filled, the Event is "OnNativeMessage" and IsNative always true.
|
||||
// This event should be defined under an empty namespace in order this to work.
|
||||
OnNativeMessage = neffos.OnNativeMessage
|
||||
|
||||
// IsSystemEvent reports whether the "event" is a system event,
|
||||
// OnNamespaceConnect, OnNamespaceConnected, OnNamespaceDisconnect,
|
||||
// OnRoomJoin, OnRoomJoined, OnRoomLeave and OnRoomLeft.
|
||||
IsSystemEvent = neffos.IsSystemEvent
|
||||
// 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".
|
||||
Reply = neffos.Reply
|
||||
)
|
||||
|
||||
// Handler returns an Iris handler to be served in a route of an Iris application.
|
||||
func Handler(s *neffos.Server) context.Handler {
|
||||
return func(ctx context.Context) {
|
||||
s.Upgrade(ctx.ResponseWriter(), ctx.Request(), func(socket neffos.Socket) neffos.Socket {
|
||||
return &socketWrapper{
|
||||
Socket: socket,
|
||||
ctx: ctx,
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
type socketWrapper struct {
|
||||
neffos.Socket
|
||||
ctx context.Context
|
||||
}
|
||||
|
||||
// GetContext returns the Iris Context from a websocket connection.
|
||||
func GetContext(c *neffos.Conn) context.Context {
|
||||
if sw, ok := c.Socket().(*socketWrapper); ok {
|
||||
return sw.ctx
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user