update udp example

Author: briansorahan

README.md

@@ -3,3 +3,22 @@
 [Open Sound Control 1.0](http://opensoundcontrol.org/spec-1_0) for Go.
 
 [![Go Report Card](https://goreportcard.com/badge/github.com/scgolang/osc)](https://goreportcard.com/report/github.com/scgolang/osc)
+
+## Install
+
+```
+go install github.com/scgolang/osc
+```
+
+## Usage
+
+### Server
+
+This is a fully functioning OSC server that uses UDP.
+
+```go
+package main
+
+func main() {
+}
+```

udp_example_test.go

@@ -0,0 +1,106 @@
+package osc
+
+import (
+	"fmt"
+	"log"
+	"net"
+	"time"
+)
+
+func ExampleUDPConn_pingpong() {
+	errChan := make(chan error)
+
+	// Setup the server.
+	laddr, err := net.ResolveUDPAddr("udp", "127.0.0.1:0")
+	if err != nil {
+		log.Fatal(err)
+	}
+	server, err := ListenUDP("udp", laddr)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Run the server in a new goroutine.
+	go func() {
+		errChan <- server.Serve(Dispatcher{
+			"/ping": func(msg Message) error {
+				fmt.Println("Server received ping.")
+				return server.SendTo(msg.Sender, Message{Address: "/pong"})
+			},
+			"/close": func(msg Message) error {
+				if err := server.SendTo(msg.Sender, Message{Address: "/close"}); err != nil {
+					_ = server.Close()
+					return err
+				}
+				fmt.Println("Server closing.")
+				return server.Close()
+			},
+		})
+	}()
+
+	// Setup the client.
+	raddr, err := net.ResolveUDPAddr("udp", server.LocalAddr().String())
+	if err != nil {
+		log.Fatal(err)
+	}
+	client, err := DialUDP("udp", nil, raddr)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Clients are also servers!
+	var (
+		pongChan        = make(chan struct{})
+		clientCloseChan = make(chan struct{})
+	)
+
+	go func() {
+		errChan <- client.Serve(Dispatcher{
+			"/pong": func(msg Message) error {
+				fmt.Println("Client received pong.")
+				close(pongChan)
+				return nil
+			},
+			"/close": func(msg Message) error {
+				fmt.Println("Client closing.")
+				close(clientCloseChan)
+				return client.Close()
+			},
+		})
+	}()
+
+	// Send the ping message, wait for the pong, then close both connections.
+	if err := client.Send(Message{Address: "/ping"}); err != nil {
+		log.Fatal(err)
+	}
+	select {
+	case <-time.After(2 * time.Second):
+		log.Fatal("timeout")
+	case err := <-errChan:
+		if err != nil {
+			log.Fatal(err)
+		}
+	case <-pongChan:
+	}
+	if err := client.Send(Message{Address: "/close"}); err != nil {
+		log.Fatal(err)
+	}
+	select {
+	case <-time.After(2 * time.Second):
+		log.Fatal("timeout")
+	case err := <-errChan:
+		if err != nil {
+			log.Fatal(err)
+		}
+	}
+	select {
+	case <-time.After(2 * time.Second):
+		log.Fatal("timeout")
+	case <-clientCloseChan:
+	}
+	// Output:
+	// Server received ping.
+	// Client received pong.
+	// Server closing.
+	// Client closing.
+}

udp_test.go

@@ -3,7 +3,6 @@ package osc
 import (
 	"bytes"
 	"context"
-	"log"
 	"net"
 	"testing"
 	"time"
@@ -297,43 +296,6 @@ func TestUDPConnSendBundle_DispatchError(t *testing.T) {
 	}
 }
 
-func ExampleUDPConn_Send() {
-	errChan := make(chan error)
-
-	// Setup the server.
-	laddr, err := net.ResolveUDPAddr("udp", "127.0.0.1:0")
-	if err != nil {
-		log.Fatal(err)
-	}
-	server, err := ListenUDP("udp", laddr)
-	if err != nil {
-		log.Fatal(err)
-	}
-	go func() {
-		errChan <- server.Serve(map[string]Method{
-			"/close": func(msg Message) error {
-				return server.Close()
-			},
-		})
-	}()
-
-	// Setup the client.
-	raddr, err := net.ResolveUDPAddr("udp", server.LocalAddr().String())
-	if err != nil {
-		log.Fatal(err)
-	}
-	conn, err := DialUDP("udp", nil, raddr)
-	if err != nil {
-		log.Fatal(err)
-	}
-	if err := conn.Send(Message{Address: "/close"}); err != nil {
-		log.Fatal(err)
-	}
-	if err := <-errChan; err != nil {
-		log.Fatal(err)
-	}
-}
-
 // badPacket is a Packet that returns an OSC message with typetag 'Q'
 type badPacket struct{}