Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/byxor/wsio
I/O wrappers for gorilla websockets in Go (Reader/Writer implementations)
https://github.com/byxor/wsio
Last synced: 15 days ago
JSON representation
I/O wrappers for gorilla websockets in Go (Reader/Writer implementations)
- Host: GitHub
- URL: https://github.com/byxor/wsio
- Owner: byxor
- License: gpl-3.0
- Created: 2018-10-14T18:12:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-30T22:53:01.000Z (over 6 years ago)
- Last Synced: 2025-01-11T21:05:41.866Z (23 days ago)
- Language: Go
- Size: 407 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wsio
[I/O](https://golang.org/pkg/io/) helpers to be used alongside [gorilla websockets](https://www.github.com/gorilla/websocket) in Go.
[](https://godoc.org/github.com/byxor/wsio)
## Includes
* `WebsocketReader` (implements [io.Reader](https://golang.org/pkg/io/#Reader))
* `WebsocketWriter` (implements [io.Writer](https://golang.org/pkg/io/#Writer))
## Why wsio?
* It allows you to write code that interacts with websockets, without depending on websockets.
* It increases the testability of your code.
* It reduces the cost of switching networking implementations.
## Why not wsio?
* You want fine-tuned control over your websocket connections.
## Demo
Let's write an "echo" program that reads some input, prefixes it with `"ECHO: "`, and echoes it back.
For now, let's use websockets for our input and output.
Here's some boilerplate to set up an endpoint.
```go
// package...
// imports...
var upgrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool {
return true
},
}
func main() {
http.HandleFunc("/", echoHandler)
log.Fatal(http.ListenAndServe("localhost:8080", nil))
}
```
### Without wsio
```go
func echoHandler(response http.ResponseWriter, request *http.Request) {
connection, _ := upgrader.Upgrade(response, request, nil)
defer connection.Close()
for {
echo(connection)
}
}
func echo(connection *websocket.Conn) {
messageType, data, _ := connection.ReadMessage()
message := fmt.Sprintf("ECHO: %s", string(data))
connection.WriteMessage(messageType, []byte(message))
}
```
* Our `echo` function has a hardcoded dependency on websockets.
* We cannot test this function without opening a real connection.
* We cannot re-use this function for different I/O devices.
### With wsio
```go
func echoHandler(response http.ResponseWriter, request *http.Request) {
connection, _ := upgrader.Upgrade(response, request, nil)
defer connection.Close()
reader := wsio.WebsocketReader{connection}
writer := wsio.WebsocketWriter{connection}
for {
echo(&reader, &writer)
}
}
func echo(reader io.Reader, writer io.Writer) {
buffer := make([]byte, 1024)
reader.Read(buffer)
message := fmt.Sprintf("ECHO: %s", string(buffer))
writer.Write([]byte(message))
}
```
* Our `echo` function is device independent.
* We can unit test this function.
* We can re-use this function with different I/O devices.