Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willcrichton/easyws
Super-abstracted API for websockets in Go
https://github.com/willcrichton/easyws
Last synced: 23 days ago
JSON representation
Super-abstracted API for websockets in Go
- Host: GitHub
- URL: https://github.com/willcrichton/easyws
- Owner: willcrichton
- Created: 2013-05-28T19:29:07.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-06-01T05:33:32.000Z (over 11 years ago)
- Last Synced: 2024-10-22T11:42:45.943Z (2 months ago)
- Language: Go
- Size: 137 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
easyws
======
Super-abstracted API for WebSockets in Go. A generalized, reusable form of the WebSocket server implemented by [Gary Burd](http://gary.beagledreams.com/page/go-websocket-chat.html).
### The API
The `easyws` package contains exactly one exported function:
```go
easyws.Socket(path string, msgHandle func(string, *easyws.Connection, *Hub),
joinHandle func(*http.Request, *easyws.Connection, *easyws.Hub),
leaveHandle func(*http.Request, *easyws.Connection, *easyws.Hub))
```
The Socket function creates a new WebSocket at the given path and accepts three handlers: `msgHandle` for when a message is sent to the WebSocket, `joinHandle` for when a user connects to the WebSocket, and `leaveHandle` for when a user disconnects or the client otherwise closes his socket connection. Both handlers are called with the corresponding `Connection` and `Hub`. Those datatypes are as follows:
```go
type Connection struct {
ws *websocket.Conn
send chan string
h *Hub
}
type Hub struct {
connections map[*Connection]bool
receiver chan msginfo
register chan *Connection
unregister chan *Connection
onjoin func(*http.Request, *Connection, *Hub)
onleave func(*http.Request, *Connection, *Hub)
}
```
A `Connection` corresponds to a single connection on the WebSocket, and a `Hub` is a structure which holds data about a WebSocket. Note that a `Connection` struct holds another struct from the `websocket` package, which you can read more about [here](https://code.google.com/p/go/source/browse/websocket/websocket.go?repo=net).
### Example
Luckily, using `easyws` is, as the name implies, easy! Here's a short example:
```go
package main
import (
"fmt"
"log"
"github.com/willcrichton/easyws"
)
func wsOnMessage(msg string, c *easyws.Connection, h *easyws.Hub) {
fmt.Println("Received message: " + msg)
}
func wsOnJoin(r *http.Request, c *easyws.Connection, h *easyws.Hub) {
fmt.Println("New user connected")
}
func wsOnLeave(r *http.Request, c *easyws.Connection, h *easyws.Hub) {
fmt.Println("User left websocket")
}
func main(){
easyws.Socket("/ws", wsOnMessage, wsOnJoin, wsOnLeave)
log.Fatal(http.ListenAndServe(":8080", nil))
}
```
In the above example, once your Go executable is running, you could then connect to your WebSocket in Javascript as follows:
```javascript
ws = new WebSocket("ws://localhost:8080/ws");
ws.send("I AM A MESSAGE");
````