support multiple .orbit files with new transport

.travis.yml

@@ -1,7 +1,6 @@
 language: go
 
 go:
-  - 1.14.x
   - 1.15.x
   - 1.16.x
 

AUTHORS

@@ -1,2 +1,2 @@
-Roland Singer <roland.singer@desertbit.com>
-Sebastian Borchers <sebastian@desertbit.com>
+Roland Singer <roland.singer[at]desertbit.com>
+Sebastian Borchers <sebastian[at]desertbit.com>

TODO.md

@@ -1,8 +1,8 @@
 # TODO
 - write tests
 - complete full example
-- finish documenting
+- finish documentation
 - Include go report in readme (and fix issues that it reports beforehand)
 - add orbit fmt cmd for .orbit files
 - disconnect session after TTL?
-- use tls.dialContext in yamux, once the new go version has come out
+- rework sample (it is more of a test right now, would be nicer if the simple one shows the minimal needed setup, and a full one almost all of the features available)

cmd/orbit/gen.go

@@ -28,37 +28,35 @@
 package main
 
 import (
-	"errors"
-
 	"github.com/desertbit/grumble"
 	"github.com/desertbit/orbit/internal/codegen/gen"
 )
 
 const (
 	flagForce = "force"
+
+	argFiles = "files"
 )
 
 var cmdGen = &grumble.Command{
-	Name:      "gen",
-	Help:      "generate go code from .orbit file. Args: <files>",
-	AllowArgs: true,
-	Run:       runGen,
+	Name: "gen",
+	Help: "generate go code from .orbit file",
+	Run:  runGen,
 	Flags: func(f *grumble.Flags) {
 		f.Bool("f", flagForce, false, "generate all files, ignoring their last modification time")
 	},
+	Args: func(a *grumble.Args) {
+		a.StringList(argFiles, "The .orbit files the code should be generated for", grumble.Min(1))
+	},
 }
 
 func init() {
 	App.AddCommand(cmdGen)
 }
 
 func runGen(ctx *grumble.Context) (err error) {
-	if len(ctx.Args) == 0 {
-		return errors.New("no file given")
-	}
-
 	// Iterate over each provided file path and generate the .orbit file.
-	for _, fp := range ctx.Args {
+	for _, fp := range ctx.Args.StringList(argFiles) {
 		err = gen.Generate(fp, ctx.Flags.Bool(flagForce))
 		if err != nil {
 			return

examples/full/api/api_orbit_gen.go

@@ -6,6 +6,7 @@ import (
 	errors "errors"
 	fmt "fmt"
 	closer "github.com/desertbit/closer/v3"
+	options "github.com/desertbit/options"
 	oclient "github.com/desertbit/orbit/pkg/client"
 	codec "github.com/desertbit/orbit/pkg/codec"
 	packet "github.com/desertbit/orbit/pkg/packet"
@@ -334,7 +335,11 @@ type client struct {
 	maxRetSize        int
 }
 
-func NewClient(opts *oclient.Options) (c Client, err error) {
+func NewClient(opts oclient.Options) (c Client, err error) {
+	err = options.SetDefaults(&opts, oclient.DefaultOptions())
+	if err != nil {
+		return
+	}
 	oc, err := oclient.New(opts)
 	if err != nil {
 		return
@@ -512,7 +517,11 @@ type service struct {
 	maxRetSize int
 }
 
-func NewService(h ServiceHandler, opts *oservice.Options) (s Service, err error) {
+func NewService(h ServiceHandler, opts oservice.Options) (s Service, err error) {
+	err = options.SetDefaults(&opts, oservice.DefaultOptions())
+	if err != nil {
+		return
+	}
 	os, err := oservice.New(opts)
 	if err != nil {
 		return

examples/simple/client/main.go

@@ -36,13 +36,16 @@ import (
 	"time"
 
 	"github.com/desertbit/orbit/examples/simple/hello"
+	"github.com/desertbit/orbit/examples/simple/world"
 	"github.com/desertbit/orbit/pkg/client"
 	olog "github.com/desertbit/orbit/pkg/hook/log"
+	"github.com/desertbit/orbit/pkg/transport/mux"
 	"github.com/desertbit/orbit/pkg/transport/quic"
 )
 
 func main() {
-	tr, err := quic.NewTransport(&quic.Options{
+	qtr, err := quic.NewTransport(quic.Options{
+		DialAddr: "127.0.0.1:1122",
 		TLSConfig: &tls.Config{
 			InsecureSkipVerify: true,
 			NextProtos:         []string{"orbit-simple-example"},
@@ -52,9 +55,14 @@ func main() {
 		log.Fatalln(err)
 	}
 
-	c, err := hello.NewClient(&client.Options{
-		Host:      "127.0.0.1:1122",
-		Transport: tr,
+	// Multiplex transport to allow multiple services.
+	mtr, err := mux.New(qtr, mux.DefaultOptions())
+	if err != nil {
+		return
+	}
+
+	c, err := hello.NewClient(client.Options{
+		Transport: mtr.Transport("hello"),
 		Hooks: client.Hooks{
 			olog.ClientHook(),
 		},
@@ -64,6 +72,17 @@ func main() {
 	}
 	defer c.Close()
 
+	wc, err := world.NewClient(client.Options{
+		Transport: mtr.Transport("world"),
+		Hooks: client.Hooks{
+			olog.ClientHook(),
+		},
+	})
+	if err != nil {
+		log.Fatalln(err)
+	}
+	defer wc.Close()
+
 	var wg sync.WaitGroup
 	wg.Add(1)
 	go func() {
@@ -115,4 +134,9 @@ func main() {
 	}
 	bi.Close()
 	wg.Wait()
+
+	err = wc.YetAnotherCall(context.Background(), world.YetAnotherCallArg{S: "Finally done"})
+	if err != nil {
+		return
+	}
 }

examples/simple/hello/hello_orbit_gen.go

@@ -6,6 +6,7 @@ import (
 	errors "errors"
 	fmt "fmt"
 	closer "github.com/desertbit/closer/v3"
+	options "github.com/desertbit/options"
 	oclient "github.com/desertbit/orbit/pkg/client"
 	codec "github.com/desertbit/orbit/pkg/codec"
 	packet "github.com/desertbit/orbit/pkg/packet"
@@ -368,7 +369,11 @@ type client struct {
 	maxRetSize        int
 }
 
-func NewClient(opts *oclient.Options) (c Client, err error) {
+func NewClient(opts oclient.Options) (c Client, err error) {
+	err = options.SetDefaults(&opts, oclient.DefaultOptions())
+	if err != nil {
+		return
+	}
 	oc, err := oclient.New(opts)
 	if err != nil {
 		return
@@ -479,7 +484,11 @@ type service struct {
 	maxRetSize int
 }
 
-func NewService(h ServiceHandler, opts *oservice.Options) (s Service, err error) {
+func NewService(h ServiceHandler, opts oservice.Options) (s Service, err error) {
+	err = options.SetDefaults(&opts, oservice.DefaultOptions())
+	if err != nil {
+		return
+	}
 	os, err := oservice.New(opts)
 	if err != nil {
 		return

examples/simple/service/main.go

@@ -39,24 +39,33 @@ import (
 	"time"
 
 	"github.com/desertbit/orbit/examples/simple/hello"
+	"github.com/desertbit/orbit/examples/simple/world"
 	olog "github.com/desertbit/orbit/pkg/hook/log"
 	"github.com/desertbit/orbit/pkg/service"
 	"github.com/desertbit/orbit/pkg/transport"
+	"github.com/desertbit/orbit/pkg/transport/mux"
 	"github.com/desertbit/orbit/pkg/transport/quic"
 )
 
 func main() {
-	tr, err := quic.NewTransport(&quic.Options{
-		TLSConfig: generateTLSConfig(),
+	// Create quic transport.
+	qtr, err := quic.NewTransport(quic.Options{
+		ListenAddr: "127.0.0.1:1122",
+		TLSConfig:  generateTLSConfig(),
 	})
 	if err != nil {
 		log.Fatalln(err)
 	}
 
+	// Multiplex transport to allow multiple services.
+	mtr, err := mux.New(qtr, mux.DefaultOptions())
+	if err != nil {
+		return
+	}
+
 	s, err := hello.NewService(&ServiceHandler{},
-		&service.Options{
-			ListenAddr: ":1122",
-			Transport:  tr,
+		service.Options{
+			Transport: mtr.Transport("hello"),
 			Hooks: service.Hooks{
 				olog.ServiceHook(),
 			},
@@ -66,7 +75,26 @@ func main() {
 	}
 	defer s.Close()
 
-	err = s.Run()
+	go func() {
+		err = s.Run()
+		if err != nil {
+			log.Fatalln(err)
+		}
+	}()
+
+	ws, err := world.NewService(&ServiceHandler{},
+		service.Options{
+			Transport: mtr.Transport("world"),
+			Hooks: service.Hooks{
+				olog.ServiceHook(),
+			},
+		})
+	if err != nil {
+		log.Fatalln(err)
+	}
+	defer ws.Close()
+
+	err = ws.Run()
 	if err != nil {
 		log.Fatalln(err)
 	}
@@ -99,6 +127,8 @@ func generateTLSConfig() *tls.Config {
 
 type ServiceHandler struct{}
 
+// ### hello service
+
 func (s *ServiceHandler) SayHi(ctx service.Context, arg hello.SayHiArg) (ret hello.SayHiRet, err error) {
 	fmt.Printf("handler: SayHi, %s, %s\n", arg.Name, arg.Ts.String())
 	ret = hello.SayHiRet{Res: []int{1, 2, 3}}
@@ -149,3 +179,10 @@ func (s *ServiceHandler) Bidirectional(ctx service.Context, stream *hello.Bidire
 	}
 	return nil
 }
+
+// ### world service
+
+func (s *ServiceHandler) YetAnotherCall(ctx service.Context, arg world.YetAnotherCallArg) (err error) {
+	fmt.Printf("world: YAC -> %s\n", arg.S)
+	return
+}

examples/simple/world/world.orbit

@@ -0,0 +1,9 @@
+version 1
+
+service {
+    call yetAnotherCall {
+        arg: {
+            s string
+        }
+    }
+}