diff options
author | Francisco Souza <franciscossouza@gmail.com> | 2012-09-06 15:22:57 +1000 |
---|---|---|
committer | Andrew Gerrand <adg@golang.org> | 2012-09-06 15:22:57 +1000 |
commit | 3b94eae23ed7b2c217c37ad316fe2b6f794000d6 (patch) | |
tree | bef39693767d38ff98d8f093b0049c0a123b4cb2 /websocket | |
parent | 67afa4a3985a096b4cbb3c237eb358962ee739c4 (diff) | |
download | net-3b94eae23ed7b2c217c37ad316fe2b6f794000d6.tar.gz |
go.net/websocket: fix server and client examples
Fix import path, and remove some unnecessary semicolons.
R=golang-dev, dave, adg
CC=golang-dev
https://golang.org/cl/6506068
Diffstat (limited to 'websocket')
-rw-r--r-- | websocket/client.go | 32 | ||||
-rw-r--r-- | websocket/exampledial_test.go | 31 | ||||
-rw-r--r-- | websocket/examplehandler_test.go | 26 | ||||
-rw-r--r-- | websocket/server.go | 27 |
4 files changed, 59 insertions, 57 deletions
diff --git a/websocket/client.go b/websocket/client.go index 1b82e9c..1eb0e9f 100644 --- a/websocket/client.go +++ b/websocket/client.go @@ -64,37 +64,7 @@ func NewClient(config *Config, rwc io.ReadWriteCloser) (ws *Conn, err error) { return } -/* -Dial opens a new client connection to a WebSocket. - -A trivial example client: - - package main - - import ( - "log" - "net/http" - "strings" - "websocket" - ) - - func main() { - origin := "http://localhost/" - url := "ws://localhost/ws" - ws, err := websocket.Dial(url, "", origin) - if err != nil { - log.Fatal(err) - } - if _, err := ws.Write([]byte("hello, world!\n")); err != nil { - log.Fatal(err) - } - var msg = make([]byte, 512); - if n, err := ws.Read(msg); err != nil { - log.Fatal(err) - } - // use msg[0:n] - } -*/ +// Dial opens a new client connection to a WebSocket. func Dial(url_, protocol, origin string) (ws *Conn, err error) { config, err := NewConfig(url_, origin) if err != nil { diff --git a/websocket/exampledial_test.go b/websocket/exampledial_test.go new file mode 100644 index 0000000..777a668 --- /dev/null +++ b/websocket/exampledial_test.go @@ -0,0 +1,31 @@ +// Copyright 2012 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +package websocket_test + +import ( + "fmt" + "log" + + "code.google.com/p/go.net/websocket" +) + +// This example demonstrates a trivial client. +func ExampleDial() { + origin := "http://localhost/" + url := "ws://localhost:12345/ws" + ws, err := websocket.Dial(url, "", origin) + if err != nil { + log.Fatal(err) + } + if _, err := ws.Write([]byte("hello, world!\n")); err != nil { + log.Fatal(err) + } + var msg = make([]byte, 512) + var n int + if n, err = ws.Read(msg); err != nil { + log.Fatal(err) + } + fmt.Printf("Received: %s.\n", msg[:n]) +} diff --git a/websocket/examplehandler_test.go b/websocket/examplehandler_test.go new file mode 100644 index 0000000..47b0bb9 --- /dev/null +++ b/websocket/examplehandler_test.go @@ -0,0 +1,26 @@ +// Copyright 2012 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +package websocket_test + +import ( + "io" + "net/http" + + "code.google.com/p/go.net/websocket" +) + +// Echo the data received on the WebSocket. +func EchoServer(ws *websocket.Conn) { + io.Copy(ws, ws) +} + +// This example demonstrates a trivial echo server. +func ExampleHandler() { + http.Handle("/echo", websocket.Handler(EchoServer)) + err := http.ListenAndServe(":12345", nil) + if err != nil { + panic("ListenAndServe: " + err.Error()) + } +} diff --git a/websocket/server.go b/websocket/server.go index d1c2cc3..428bfb4 100644 --- a/websocket/server.go +++ b/websocket/server.go @@ -52,32 +52,7 @@ func newServerConn(rwc io.ReadWriteCloser, buf *bufio.ReadWriter, req *http.Requ return } -/* -Handler is an interface to a WebSocket. - -A trivial example server: - - package main - - import ( - "io" - "net/http" - "websocket" - ) - - // Echo the data received on the WebSocket. - func EchoServer(ws *websocket.Conn) { - io.Copy(ws, ws); - } - - func main() { - http.Handle("/echo", websocket.Handler(EchoServer)); - err := http.ListenAndServe(":12345", nil); - if err != nil { - panic("ListenAndServe: " + err.Error()) - } - } -*/ +// Handler is an interface to a WebSocket. type Handler func(*Conn) // ServeHTTP implements the http.Handler interface for a Web Socket |