sed -i '' 's;MessageHandlers;PatternMatching;' *.go

Author: briansorahan

dispatcher.go

@@ -31,11 +31,12 @@ type Dispatcher interface {
 	Invoke(msg Message, exactMatch bool) error
 }
 
-// MessageHandlers is a map from OSC address pattern to message handler.
-type MessageHandlers map[string]MessageHandler
+// PatternMatching is a dispatcher that implements OSC 1.0 pattern matching.
+// See http://opensoundcontrol.org/spec-1_0 "OSC Message Dispatching and Pattern Matching"
+type PatternMatching map[string]MessageHandler
 
 // Dispatch invokes an OSC bundle's messages.
-func (h MessageHandlers) Dispatch(b Bundle, exactMatch bool) error {
+func (h PatternMatching) Dispatch(b Bundle, exactMatch bool) error {
 	var (
 		now = time.Now()
 		tt  = b.Timetag.Time()
@@ -48,7 +49,7 @@ func (h MessageHandlers) Dispatch(b Bundle, exactMatch bool) error {
 }
 
 // immediately invokes an OSC bundle immediately.
-func (h MessageHandlers) immediately(b Bundle, exactMatch bool) error {
+func (h PatternMatching) immediately(b Bundle, exactMatch bool) error {
 	for _, p := range b.Packets {
 		errs := []string{}
 		if err := h.invoke(p, exactMatch); err != nil {
@@ -63,7 +64,7 @@ func (h MessageHandlers) immediately(b Bundle, exactMatch bool) error {
 }
 
 // invoke invokes an OSC packet, which could be a message or a bundle of messages.
-func (h MessageHandlers) invoke(p Packet, exactMatch bool) error {
+func (h PatternMatching) invoke(p Packet, exactMatch bool) error {
 	switch x := p.(type) {
 	case Message:
 		return h.Invoke(x, exactMatch)
@@ -75,7 +76,7 @@ func (h MessageHandlers) invoke(p Packet, exactMatch bool) error {
 }
 
 // Invoke invokes an OSC message.
-func (h MessageHandlers) Invoke(msg Message, exactMatch bool) error {
+func (h PatternMatching) Invoke(msg Message, exactMatch bool) error {
 	for address, handler := range h {
 		matched, err := msg.Match(address, exactMatch)
 		if err != nil {

dispatcher_test.go

@@ -10,7 +10,7 @@ import (
 // Test a successful method invocation.
 func TestDispatcherDispatchOK(t *testing.T) {
 	c := make(chan struct{})
-	d := MessageHandlers{
+	d := PatternMatching{
 		"/bar": Method(func(msg Message) error {
 			close(c)
 			return nil
@@ -31,7 +31,7 @@ func TestDispatcherDispatchOK(t *testing.T) {
 
 // Test a method that returns an error.
 func TestDispatcherDispatchError(t *testing.T) {
-	d := MessageHandlers{
+	d := PatternMatching{
 		"/foo": Method(func(msg Message) error {
 			return errors.New("oops")
 		}),
@@ -50,7 +50,7 @@ func TestDispatcherDispatchError(t *testing.T) {
 
 func TestDispatcherDispatchNestedBundle(t *testing.T) {
 	c := make(chan struct{})
-	d := MessageHandlers{
+	d := PatternMatching{
 		"/foo": Method(func(msg Message) error {
 			close(c)
 			return nil
@@ -75,7 +75,7 @@ func TestDispatcherDispatchNestedBundle(t *testing.T) {
 }
 
 func TestDispatcherMiss(t *testing.T) {
-	d := MessageHandlers{
+	d := PatternMatching{
 		"/foo": Method(func(msg Message) error {
 			return nil
 		}),
@@ -89,7 +89,7 @@ func TestDispatcherMiss(t *testing.T) {
 }
 
 func TestDispatcherInvoke(t *testing.T) {
-	d := MessageHandlers{
+	d := PatternMatching{
 		"/foo": Method(func(msg Message) error {
 			return errors.New("foo error")
 		}),

osc.go

@@ -112,7 +112,7 @@ func checkDispatcher(dispatcher Dispatcher) error {
 	if dispatcher == nil {
 		return ErrNilDispatcher
 	}
-	messageHandlers, ok := dispatcher.(MessageHandlers)
+	messageHandlers, ok := dispatcher.(PatternMatching)
 	if ok {
 		for addr := range messageHandlers {
 			if err := ValidateAddress(addr); err != nil {

pingpong_example_test.go

@@ -66,7 +66,7 @@ func Example_pingPong() {
 }
 
 func serverDispatch(server *UDPConn, errChan chan error) {
-	errChan <- server.Serve(1, MessageHandlers{
+	errChan <- server.Serve(1, PatternMatching{
 		"/ping": Method(func(msg Message) error {
 			fmt.Println("Server received ping.")
 			return server.SendTo(msg.Sender, Message{Address: "/pong"})
@@ -83,7 +83,7 @@ func serverDispatch(server *UDPConn, errChan chan error) {
 }
 
 func clientDispatch(client *UDPConn, errChan chan error, pongChan chan struct{}, closeChan chan struct{}) {
-	errChan <- client.Serve(1, MessageHandlers{
+	errChan <- client.Serve(1, PatternMatching{
 		"/pong": Method(func(msg Message) error {
 			fmt.Println("Client received pong.")
 			close(pongChan)

udp_test.go

@@ -21,7 +21,7 @@ func TestInvalidAddress(t *testing.T) {
 	}
 	defer func() { _ = server.Close() }() // Best effort.
 
-	if err := server.Serve(1, MessageHandlers{
+	if err := server.Serve(1, PatternMatching{
 		"/[": Method(func(msg Message) error {
 			return nil
 		}),
@@ -72,7 +72,7 @@ func TestDialUDPContext(t *testing.T) {
 	if c.Context() != ctxTimeout {
 		t.Fatalf("expected %+v to be %+v", ctxTimeout, c.Context())
 	}
-	if err := c.Serve(1, MessageHandlers{}); err != context.DeadlineExceeded {
+	if err := c.Serve(1, PatternMatching{}); err != context.DeadlineExceeded {
 		t.Fatalf("expected context.DeadlineExceeded, got %+v", err)
 	}
 }
@@ -83,7 +83,7 @@ func TestDialUDPContext(t *testing.T) {
 // For clients that are interested in closing the server with an OSC
 // message, a method is automatically added to the provided dispatcher
 // at the "/server/close" address that closes the server.
-func testUDPServer(t *testing.T, dispatcher MessageHandlers) (*UDPConn, *UDPConn, chan error) {
+func testUDPServer(t *testing.T, dispatcher PatternMatching) (*UDPConn, *UDPConn, chan error) {
 	laddr, err := net.ResolveUDPAddr("udp", "127.0.0.1:0")
 	if err != nil {
 		t.Fatal(err)
@@ -93,7 +93,7 @@ func testUDPServer(t *testing.T, dispatcher MessageHandlers) (*UDPConn, *UDPConn
 		t.Fatal(err)
 	}
 	if dispatcher == nil {
-		dispatcher = MessageHandlers{}
+		dispatcher = PatternMatching{}
 	}
 	dispatcher["/server/close"] = Method(func(msg Message) error {
 		return server.Close()
@@ -158,7 +158,7 @@ func TestUDPConnServe_ContextTimeout(t *testing.T) {
 	}
 	errChan := make(chan error)
 	go func() {
-		errChan <- server.Serve(1, MessageHandlers{})
+		errChan <- server.Serve(1, PatternMatching{})
 	}()
 	select {
 	case <-time.After(200 * time.Millisecond):
@@ -187,7 +187,7 @@ func TestUDPConnServe_ReadError(t *testing.T) {
 		ctx:     context.Background(),
 	}
 	go func() {
-		errChan <- server.Serve(1, MessageHandlers{
+		errChan <- server.Serve(1, PatternMatching{
 			"/close": Method(func(msg Message) error {
 				return server.Close()
 			}),
@@ -233,7 +233,7 @@ func TestUDPConnServe_BadInboundAddr(t *testing.T) {
 		badPacket{},
 	} {
 		// Send a message with a bad address.
-		_, conn, errChan := testUDPServer(t, MessageHandlers{
+		_, conn, errChan := testUDPServer(t, PatternMatching{
 			"/foo": Method(func(msg Message) error {
 				return nil
 			}),
@@ -305,7 +305,7 @@ func TestUDPConnSendBundle_DispatchError(t *testing.T) {
 			Message{Address: "/foo"},
 		},
 	}
-	_, conn, errChan := testUDPServer(t, MessageHandlers{
+	_, conn, errChan := testUDPServer(t, PatternMatching{
 		"/foo": Method(func(msg Message) error {
 			return errors.New("oops")
 		}),

unix_test.go

@@ -30,7 +30,7 @@ func tmpListener(t *testing.T, dispatcher Dispatcher) (*UnixConn, chan error) {
 func TestUnixSend(t *testing.T) {
 	fooch := make(chan struct{})
 
-	server, errChan := tmpListener(t, MessageHandlers{
+	server, errChan := tmpListener(t, PatternMatching{
 		"/foo": Method(func(m Message) error {
 			close(fooch)
 			return nil
@@ -113,7 +113,7 @@ func TestDialUnixSetWriteBufferError(t *testing.T) {
 func TestUnixSendTo(t *testing.T) {
 	fooch := make(chan struct{})
 
-	server, errChan := tmpListener(t, MessageHandlers{
+	server, errChan := tmpListener(t, PatternMatching{
 		"/foo": Method(func(m Message) error {
 			close(fooch)
 			return nil