Remove some redundancy in websocketconn naming.

Rename websocketconn.WebSocketConn to websocketconn.Conn, and
       websocketconn.NewWebSocketConn to websocketconn.New

Following the guidelines at
https://blog.golang.org/package-names#TOC_3%2e
This commit is contained in:
David Fifield 2020-01-28 00:54:26 -07:00
parent 5b01df9030
commit e47dd5e2b4
4 changed files with 13 additions and 13 deletions

View file

@ -9,13 +9,13 @@ import (
// An abstraction that makes an underlying WebSocket connection look like an // An abstraction that makes an underlying WebSocket connection look like an
// io.ReadWriteCloser. // io.ReadWriteCloser.
type WebSocketConn struct { type Conn struct {
Ws *websocket.Conn Ws *websocket.Conn
r io.Reader r io.Reader
} }
// Implements io.Reader. // Implements io.Reader.
func (conn *WebSocketConn) Read(b []byte) (n int, err error) { func (conn *Conn) Read(b []byte) (n int, err error) {
var opCode int var opCode int
if conn.r == nil { if conn.r == nil {
// New message // New message
@ -43,7 +43,7 @@ func (conn *WebSocketConn) Read(b []byte) (n int, err error) {
} }
// Implements io.Writer. // Implements io.Writer.
func (conn *WebSocketConn) Write(b []byte) (n int, err error) { func (conn *Conn) Write(b []byte) (n int, err error) {
var w io.WriteCloser var w io.WriteCloser
if w, err = conn.Ws.NextWriter(websocket.BinaryMessage); err != nil { if w, err = conn.Ws.NextWriter(websocket.BinaryMessage); err != nil {
return return
@ -56,15 +56,15 @@ func (conn *WebSocketConn) Write(b []byte) (n int, err error) {
} }
// Implements io.Closer. // Implements io.Closer.
func (conn *WebSocketConn) Close() error { func (conn *Conn) Close() error {
// Ignore any error in trying to write a Close frame. // Ignore any error in trying to write a Close frame.
_ = conn.Ws.WriteControl(websocket.CloseMessage, []byte{}, time.Now().Add(time.Second)) _ = conn.Ws.WriteControl(websocket.CloseMessage, []byte{}, time.Now().Add(time.Second))
return conn.Ws.Close() return conn.Ws.Close()
} }
// Create a new WebSocketConn. // Create a new Conn.
func NewWebSocketConn(ws *websocket.Conn) WebSocketConn { func New(ws *websocket.Conn) Conn {
var conn WebSocketConn var conn Conn
conn.Ws = ws conn.Ws = ws
return conn return conn
} }

View file

@ -285,7 +285,7 @@ func datachannelHandler(conn *webRTCConn, remoteAddr net.Addr) {
log.Printf("error dialing relay: %s", err) log.Printf("error dialing relay: %s", err)
return return
} }
wsConn := websocketconn.NewWebSocketConn(ws) wsConn := websocketconn.New(ws)
log.Printf("connected to relay") log.Printf("connected to relay")
defer wsConn.Close() defer wsConn.Close()
CopyLoop(conn, &wsConn) CopyLoop(conn, &wsConn)

View file

@ -52,7 +52,7 @@ additional HTTP listener on port 80 to work with ACME.
} }
// Copy from WebSocket to socket and vice versa. // Copy from WebSocket to socket and vice versa.
func proxy(local *net.TCPConn, conn *websocketconn.WebSocketConn) { func proxy(local *net.TCPConn, conn *websocketconn.Conn) {
var wg sync.WaitGroup var wg sync.WaitGroup
wg.Add(2) wg.Add(2)
@ -107,7 +107,7 @@ func (handler *HTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
return return
} }
conn := websocketconn.NewWebSocketConn(ws) conn := websocketconn.New(ws)
defer conn.Close() defer conn.Close()
// Pass the address of client as the remote address of incoming connection // Pass the address of client as the remote address of incoming connection

View file

@ -60,7 +60,7 @@ type StubHandler struct{}
func (handler *StubHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { func (handler *StubHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
ws, _ := upgrader.Upgrade(w, r, nil) ws, _ := upgrader.Upgrade(w, r, nil)
conn := websocketconn.NewWebSocketConn(ws) conn := websocketconn.New(ws)
defer conn.Close() defer conn.Close()
//dial stub OR //dial stub OR
@ -90,7 +90,7 @@ func Test(t *testing.T) {
So(err, ShouldBeNil) So(err, ShouldBeNil)
ws, _, err := websocket.DefaultDialer.Dial("ws://localhost:8888", nil) ws, _, err := websocket.DefaultDialer.Dial("ws://localhost:8888", nil)
wsConn := websocketconn.NewWebSocketConn(ws) wsConn := websocketconn.New(ws)
So(err, ShouldEqual, nil) So(err, ShouldEqual, nil)
So(wsConn, ShouldNotEqual, nil) So(wsConn, ShouldNotEqual, nil)
@ -133,7 +133,7 @@ func Test(t *testing.T) {
ws, _, err := websocket.DefaultDialer.Dial("ws://localhost:8888", nil) ws, _, err := websocket.DefaultDialer.Dial("ws://localhost:8888", nil)
So(err, ShouldEqual, nil) So(err, ShouldEqual, nil)
wsConn := websocketconn.NewWebSocketConn(ws) wsConn := websocketconn.New(ws)
So(wsConn, ShouldNotEqual, nil) So(wsConn, ShouldNotEqual, nil)
wsConn.Write([]byte("Hello")) wsConn.Write([]byte("Hello"))