Add streaming support

bep · Mar 25, 2024 · e4d0561 · e4d0561
1 parent 2c5a478
commit e4d0561
Show file tree

Hide file tree

Showing 13 changed files with 599 additions and 310 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,40 +1,40 @@
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
 name: Test
 jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.21.x, 1.22.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v3
-      with:
-        go-version: ${{ matrix.go-version }}
-    - name: Install staticcheck
-      run: go install honnef.co/go/tools/cmd/staticcheck@latest
-      shell: bash
-    - name: Install golint
-      run: go install golang.org/x/lint/golint@latest
-      shell: bash
-    - name: Update PATH
-      run: echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
-      shell: bash
-    - name: Checkout code
-      uses: actions/checkout@v1
-    - name: Fmt
-      if: matrix.platform != 'windows-latest' # :(
-      run: "diff <(gofmt -d .) <(printf '')"
-      shell: bash
-    - name: Vet
-      run: go vet ./...
-    - name: Staticcheck
-      run: staticcheck ./...
-    - name: Lint
-      run: golint ./...
-    - name: Test
-      run: go test -race ./...
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/staticcheck@latest
+        shell: bash
+      - name: Install golint
+        run: go install golang.org/x/lint/golint@latest
+        shell: bash
+      - name: Update PATH
+        run: echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+        shell: bash
+      - name: Checkout code
+        uses: actions/checkout@v1
+      - name: Fmt
+        if: matrix.platform != 'windows-latest' # :(
+        run: "diff <(gofmt -d .) <(printf '')"
+        shell: bash
+      - name: Vet
+        run: go vet ./...
+      - name: Staticcheck
+        run: staticcheck ./...
+      - name: Lint
+        run: golint ./...
+      - name: Test
+        run: go test -race ./...
diff --git a/README.md b/README.md
@@ -5,29 +5,7 @@
 This library implements a simple, custom [RPC protocol](https://en.wikipedia.org/wiki/Remote_procedure_call) via [os/exex](https://pkg.go.dev/os/exec) and stdin and stdout. Both server and client comes in a raw (`[]byte`) and strongly typed variant (using Go generics).
 
 A strongly typed client may look like this:
-
-```go
-client, err := execrpc.StartClient(
-		execrpc.ClientOptions[model.ExampleRequest, model.ExampleResponse]{
-			ClientRawOptions: execrpc.ClientRawOptions{
-				Version: 1,
-				Cmd:     "go",
-				Dir:  "./examples/servers/typed"
-				Args:    []string{"run", "."},
-			},
-			Codec: codecs.JSONCodec[model.ExampleRequest, model.ExampleResponse]{},
-		},
-	)
-
-result, _ := client.Execute(model.ExampleRequest{Text: "world"})
-
-fmt.Println(result.Hello)
-
-//...
-
-client.Close()
-
-```
+TODO1.
 
 To get the best performance you should keep the client open as long as its needed – and store it as a shared object; it's safe and encouraged to call `Execute` from multiple goroutines.