Neptulon is a bidirectional RPC framework with middleware support. Communication protocol is JSON-RPC over WebSockets which is full-duplex bidirectional.
Neptulon framework is only about 400 lines of code, which makes it easy to fork, specialize, and maintain for specific purposes, if you need to.
Following is a server for echoing all incoming messages as is:
s := neptulon.NewServer("127.0.0.1:3000")
s.MiddlewareFunc(middleware.Echo)
s.ListenAndServe()Following is a client connection to the above server. You can also use WebSocket Test Page from your browser to connect to the server.
c, _ := neptulon.NewConn()
c.Connect("ws://127.0.0.1:3000")
c.SendRequest("echo", map[string]string{"message": "Hello!"}, func(ctx *neptulon.ResCtx) error {
var msg interface{}
err := ctx.Result(&msg)
fmt.Println("Server sent:", msg)
return err
})For a more comprehensive example, see example_test.go file.
Both the Server and client Conn types have the same middleware handler signature: Middleware(func(ctx *ReqCtx) error). Since both the server and the client can send request messages to each other, you can use the same set of middleware to for both, to handle the incoming requests.
See middleware package to get a list of all bundled middleware.
You can connect to your Neptulon server using any programming language that has WebSocket + JSON libraries. For convenience and for reference, following client modules are provided nonetheless:
- Go: Bundled conn.go file.
- Java: Package client-java. Uses OkHttp for WebSockets and GSON for JSON serialization.
Titan mobile messaging app server is written entirely using the Neptulon framework. You can visit its repo to see a complete use case of Neptulon framework.
All the tests can be executed with GORACE="halt_on_error=1" go test -race -cover ./... command. Optionally you can add -v flag to observe all connection logs.