TCP support (take 2)

README.md

@@ -7,22 +7,23 @@
 
 ## Features
 
--   OSC Bundles, including timetags
--   OSC Messages
--   OSC Client
--   OSC Server
--   Supports the following OSC argument types:
-    -   'i' (Int32)
-    -   'f' (Float32)
-    -   's' (string)
-    -   'b' (blob / binary data)
-    -   'h' (Int64)
-    -   't' (OSC timetag)
-    -   'd' (Double/int64)
-    -   'T' (True)
-    -   'F' (False)
-    -   'N' (Nil)
--   Support for OSC address pattern including '\*', '?', '{,}' and '[]' wildcards
+- UDP (default) or TCP
+- OSC Bundles, including timetags
+- OSC Messages
+- OSC Client
+- OSC Server
+- Supports the following OSC argument types:
+  - 'i' (Int32)
+  - 'f' (Float32)
+  - 's' (string)
+  - 'b' (blob / binary data)
+  - 'h' (Int64)
+  - 't' (OSC timetag)
+  - 'd' (Double/int64)
+  - 'T' (True)
+  - 'F' (False)
+  - 'N' (Nil)
+- Support for OSC address pattern including '\*', '?', '{,}' and '[]' wildcards
 
 ## Install
 

examples/basic_server/basic_server.go

@@ -67,7 +67,7 @@ func (Debugger) Dispatch(packet osc.Packet) {
 }
 
 func printUsage() {
-	fmt.Printf("Usage: %s PORT\n", os.Args[0])
+	fmt.Printf("Usage: %s PROTOCOL PORT\n", os.Args[0])
 }
 
 func main() {
@@ -80,7 +80,19 @@ func main() {
 		os.Exit(1)
 	}
 
-	port, err := strconv.ParseInt(os.Args[1], 10, 32)
+	var protocol osc.NetworkProtocol
+	switch strings.ToLower(os.Args[1]) {
+	case "udp":
+		protocol = osc.UDP
+	case "tcp":
+		protocol = osc.TCP
+	default:
+		fmt.Println("Invalid protocol: " + os.Args[1])
+		printUsage()
+		os.Exit(1)
+	}
+
+	port, err := strconv.ParseInt(os.Args[2], 10, 32)
 	if err != nil {
 		fmt.Println(err)
 		printUsage()
@@ -89,10 +101,12 @@ func main() {
 
 	addr := fmt.Sprintf("127.0.0.1:%d", port)
 
-	server := &osc.Server{Addr: addr, Dispatcher: Debugger{}}
+	server := osc.NewServer(addr, Debugger{}, 0,
+		// defaults to UDP if not used
+		osc.ServerProtocol(protocol))
 
 	fmt.Println("### Welcome to go-osc receiver demo")
-	fmt.Printf("Listening via UDP on port %d...\n", port)
+	fmt.Printf("Listening via %s on port %d...\n", protocol, port)
 
 	if err := server.ListenAndServe(); err != nil {
 		fmt.Println(err)

examples/client/client.go

@@ -73,7 +73,7 @@ func randomBundle() *osc.Bundle {
 }
 
 func printUsage() {
-	fmt.Printf("Usage: %s PORT\n", os.Args[0])
+	fmt.Printf("Usage: %s PROTOCOL PORT\n", os.Args[0])
 }
 
 func main() {
@@ -86,15 +86,27 @@ func main() {
 		os.Exit(1)
 	}
 
-	port, err := strconv.ParseInt(os.Args[1], 10, 32)
+	var protocol osc.NetworkProtocol
+	switch strings.ToLower(os.Args[1]) {
+	case "udp":
+		protocol = osc.UDP
+	case "tcp":
+		protocol = osc.TCP
+	default:
+		fmt.Println("Invalid protocol: " + os.Args[1])
+		printUsage()
+		os.Exit(1)
+	}
+
+	port, err := strconv.ParseInt(os.Args[2], 10, 32)
 	if err != nil {
 		fmt.Println(err)
 		printUsage()
 		os.Exit(1)
 	}
 
 	ip := "localhost"
-	client := osc.NewClient(ip, int(port))
+	client := osc.NewClient(ip, int(port), osc.ClientProtocol(protocol))
 
 	fmt.Println("### Welcome to go-osc transmitter demo")
 	fmt.Println("Please, select the OSC packet type you would like to send:")

examples/dispatching_server/dispatching_server.go

@@ -1,18 +1,66 @@
 package main
 
-import "github.com/hypebeast/go-osc/osc"
+import (
+	"fmt"
+	"math/rand"
+	"os"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/hypebeast/go-osc/osc"
+)
+
+func printUsage() {
+	fmt.Printf("Usage: %s PROTOCOL PORT\n", os.Args[0])
+}
 
 func main() {
-	addr := "127.0.0.1:8765"
+	rand.Seed(time.Now().Unix())
+
+	numArgs := len(os.Args[1:])
+
+	if numArgs != 2 {
+		printUsage()
+		os.Exit(1)
+	}
+
+	var protocol osc.NetworkProtocol
+	switch strings.ToLower(os.Args[1]) {
+	case "udp":
+		protocol = osc.UDP
+	case "tcp":
+		protocol = osc.TCP
+	default:
+		fmt.Println("Invalid protocol: " + os.Args[1])
+		printUsage()
+		os.Exit(1)
+	}
+
+	port, err := strconv.ParseInt(os.Args[2], 10, 32)
+	if err != nil {
+		fmt.Println(err)
+		printUsage()
+		os.Exit(1)
+	}
+
+	addr := fmt.Sprintf("127.0.0.1:%d", port)
 
 	d := osc.NewStandardDispatcher()
-	d.AddMsgHandler("/message/address", func(msg *osc.Message) {
+
+	if err := d.AddMsgHandler("/message/address", func(msg *osc.Message) {
 		osc.PrintMessage(msg)
-	})
-	server := &osc.Server{
-		Addr:       addr,
-		Dispatcher: d,
+	}); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
 	}
 
-	server.ListenAndServe()
+	server := osc.NewServer(addr, d, 0, osc.ServerProtocol(protocol))
+
+	fmt.Printf("Listening via %s on port %d...\n", protocol, port)
+
+	if err := server.ListenAndServe(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
 }

osc/doc.go

@@ -20,8 +20,8 @@ Features:
 - OSC bundles, including timetags
 - Support for OSC address pattern including '*', '?', '{,}' and '[]' wildcards
 
-This OSC implementation uses the UDP protocol for sending and receiving
-OSC packets.
+This OSC implementation supports using UDP or TCP as the protocol for sending
+and receiving OSC packets. UDP is used by default.
 
 The unit of transmission of OSC is an OSC Packet. Any application that sends
 OSC Packets is an OSC Client; any application that receives OSC Packets is
@@ -58,6 +58,8 @@ Usage
 OSC client example:
 
     client := osc.NewClient("localhost", 8765)
+    // To use TCP instead of UDP:
+    // client := osc.NewClient("localhost", 8765, osc.ClientProtocol(osc.TCP))
     msg := osc.NewMessage("/osc/address")
     msg.Append(int32(111))
     msg.Append(true)
@@ -72,10 +74,10 @@ OSC server example:
         osc.PrintMessage(msg)
     })
 
-    server := &osc.Server{
-        Addr: addr,
-        Dispatcher:d,
-    }
+		server := osc.NewServer(addr, d, 0)
+    // To use TCP instead of UDP:
+    // server := osc.NewServer(addr, d, 0, osc.ServerProtocol(osc.TCP))
+
     server.ListenAndServe()
 */
 package osc