Go quick start

Create an application with Go 1.27+:

mkdir myapp
cd myapp
go mod init example.com/myapp
go get github.com/wsrpc/wsrpc-go@main

Save this complete server as main.go. It registers a ready service object and a callback method that calls double on the client.

package main

import (
	"context"
	"log"
	"net/http"

	wsrpc "github.com/wsrpc/wsrpc-go"
	"github.com/wsrpc/wsrpc-go/ws"
)

type EchoService struct{ Prefix string }
type EchoParams struct {
	Text string `json:"text"`
}
type EchoResult struct {
	Text string `json:"text"`
}

func (s *EchoService) Echo(_ context.Context, p EchoParams) (EchoResult, error) {
	return EchoResult{Text: s.Prefix + p.Text}, nil
}

func main() {
	routes := new(wsrpc.Router)
	service := &EchoService{Prefix: "Hello, "}
	if err := routes.Handle("echo", service.Echo); err != nil {
		log.Fatal(err)
	}
	if err := routes.Handle("callback", func(ctx context.Context, p struct {
		Value int `json:"value"`
	}) (int, error) {
		peer, _ := wsrpc.FromContext(ctx)
		return peer.Call[int](ctx, "double", p)
	}); err != nil {
		log.Fatal(err)
	}
	rpc, err := ws.NewServer(ws.ServerOptions{Peer: wsrpc.Options{Routes: routes}})
	if err != nil {
		log.Fatal(err)
	}
	mux := http.NewServeMux()
	mux.Handle("/ws/", rpc)
	log.Fatal(http.ListenAndServe("127.0.0.1:8000", mux))
}

go run .

The WebSocket endpoint is ws://127.0.0.1:8000/ws/. Try the Go client, browser client, or Python client. The same methods are available to all clients; only the host-language API changes.

The server implements http.Handler, so it can be mounted on routers that use net/http. Authentication belongs in HTTP middleware or ServerOptions.Authorize. For a long-running service, configure the enclosing HTTP server’s timeouts and use the shutdown sequence.