README
¶
websocket
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455.
Feature
- Upgrade HTTP / Conn
- Epoll / Kqueue
- TLS
Benchmark
Get started
Install
go get github.com/hslam/websocket
Import
import "github.com/hslam/websocket"
Usage
Example
server.go
package main
import (
"github.com/hslam/mux"
"github.com/hslam/websocket"
"log"
"net/http"
"strings"
)
func main() {
m := mux.New()
m.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
conn, err := websocket.UpgradeHTTP(w, r)
if err != nil {
return
}
for {
var message string
err := conn.ReceiveMessage(&message)
if err != nil {
break
}
conn.SendMessage(strings.ToUpper(string(message)))
}
conn.Close()
}).GET()
log.Fatal(http.ListenAndServe(":8080", m))
}
server_poll.go
package main
import (
"github.com/hslam/netpoll"
"github.com/hslam/websocket"
"net"
"strings"
)
func main() {
var handler = &netpoll.ConnHandler{}
handler.SetUpgrade(func(conn net.Conn) (netpoll.Context, error) {
return websocket.Upgrade(conn, nil)
})
handler.SetServe(func(context netpoll.Context) error {
ws := context.(*websocket.Conn)
var message string
err := ws.ReceiveMessage(&message)
if err != nil {
return err
}
return ws.SendMessage(strings.ToUpper(string(message)))
})
if err := netpoll.ListenAndServe("tcp", ":8080", handler); err != nil {
panic(err)
}
}
client.go
package main
import (
"fmt"
"github.com/hslam/websocket"
"time"
)
func main() {
conn, err := websocket.Dial("tcp", "127.0.0.1:8080", "/", nil)
if err != nil {
panic(err)
}
defer conn.Close()
for i := 0; i < 1; i++ {
conn.SendMessage("Hello World")
var message string
err := conn.ReceiveMessage(&message)
if err != nil {
break
}
fmt.Println(message)
time.Sleep(time.Second)
}
}
Output
HELLO WORLD
client.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Websocket</title>
</head>
<body>
<h1>UPPER</h1>
<form><p>string: <input id="content" type="text" placeholder="input string"></p></form>
<label id="result">result：</label><br><br>
<button onclick="send()">upper</button>
<script type="text/javascript">
var wsuri = "ws://127.0.0.1:8080/";
var ws = new WebSocket(wsuri);
ws.onmessage = function(e) {
var result = document.getElementById('result');
result.innerHTML = "result：" + e.data;
}
function send() {
var msg = document.getElementById('content').value;
ws.send(msg);
}
</script>
</body>
</html>
License
This package is licensed under a MIT license (Copyright (c) 2020 Meng Huang)
Author
websocket was written by Meng Huang.
Documentation
¶
Overview ¶
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455.
Index ¶
- Constants
- type Conn
- func (c *Conn) Close() error
- func (c *Conn) LocalAddr() net.Addr
- func (c *Conn) Read(b []byte) (n int, err error)
- func (c *Conn) ReadMessage(buf []byte) (p []byte, err error)
- func (c *Conn) ReadTextMessage() (p string, err error)
- func (c *Conn) ReceiveMessage(v interface{}) (err error)
- func (c *Conn) RemoteAddr() net.Addr
- func (c *Conn) SendMessage(v interface{}) (err error)
- func (c *Conn) SetConcurrency(concurrency func() int)
- func (c *Conn) SetDeadline(t time.Time) error
- func (c *Conn) SetReadDeadline(t time.Time) error
- func (c *Conn) SetWriteDeadline(t time.Time) error
- func (c *Conn) Write(b []byte) (n int, err error)
- func (c *Conn) WriteMessage(b []byte) (err error)
- func (c *Conn) WriteTextMessage(b string) (err error)
- type Handler
Constants ¶
const ( // ContinuationFrame represents a WebSocket continuation frame. ContinuationFrame = 0x0 // TextFrame represents a WebSocket text frame. TextFrame = 0x1 // BinaryFrame represents a WebSocket binary frame. BinaryFrame = 0x2 // CloseFrame represents a WebSocket close frame. CloseFrame = 0x8 // PingFrame represents a WebSocket ping frame. PingFrame = 0x9 // PongFrame represents a WebSocket pong frame. PongFrame = 0xA )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Conn ¶
type Conn struct {
// contains filtered or unexported fields
}
Conn represents a WebSocket connection.
func UpgradeHTTP ¶
UpgradeHTTP upgrades the HTTP server connection to the WebSocket protocol.
func (*Conn) LocalAddr ¶
LocalAddr returns the local network address. The Addr returned is shared by all invocations of LocalAddr, so do not modify it.
func (*Conn) ReadMessage ¶
ReadMessage reads single message from ws.
func (*Conn) ReadTextMessage ¶
ReadTextMessage reads single text message from ws.
func (*Conn) ReceiveMessage ¶
ReceiveMessage receives single frame from ws, unmarshaled and stores in v.
func (*Conn) RemoteAddr ¶
RemoteAddr returns the remote network address. The Addr returned is shared by all invocations of RemoteAddr, so do not modify it.
func (*Conn) SendMessage ¶
SendMessage sends v marshaled as single frame to ws.
func (*Conn) SetConcurrency ¶
SetConcurrency sets a callback func concurrency for writer.
func (*Conn) SetDeadline ¶
SetDeadline implements the Conn SetDeadline method.
func (*Conn) SetReadDeadline ¶
SetReadDeadline implements the Conn SetReadDeadline method.
func (*Conn) SetWriteDeadline ¶
SetWriteDeadline implements the Conn SetWriteDeadline method.
func (*Conn) WriteMessage ¶
WriteMessage writes single message to ws.
func (*Conn) WriteTextMessage ¶
WriteTextMessage writes single text message to ws.
Source Files