WAMP v2 Router and Client for go.
To install xconn
, use the following command:
go get github.com/xconnio/xconn-go
Setting up a basic server is straightforward:
package main
import (
"log"
"github.com/xconnio/xconn-go"
)
func main() {
r := xconn.NewRouter()
r.AddRealm("realm1")
server := xconn.NewServer(r, nil)
err := server.Start("localhost", 8080)
if err != nil {
log.Fatalf("Failed to start server: %v", err)
}
}
For more advanced usage, such as integrating an authenticator, refer to the sample tool available in the cmd folder of the project.
Creating a client:
package main
import (
"context"
"log"
"github.com/xconnio/xconn-go"
)
func main() {
client := xconn.Client{}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatal(err)
}
}
Once the session is established, you can perform WAMP actions. Below are examples of all 4 WAMP operations:
func exampleSubscribe(session *xconn.Session) {
subscription, err := session.Subscribe("io.xconn.example", eventHandler, map[string]any{})
if err != nil {
log.Fatalf("Failed to subscribe: %v", err)
}
log.Printf("Subscribed to topic io.xconn.example: %v", subscription)
}
func eventHandler(evt *xconn.Event) {
fmt.Printf("Event Received: args=%s, kwargs=%s, details=%s", evt.Args, evt.KwArgs, evt.Details)
}
func examplePublish(session *xconn.Session) {
err := session.Publish("io.xconn.example", []any{}, map[string]any{}, map[string]any{})
if err != nil {
log.Fatalf("Failed to publish: %v", err)
}
log.Printf("Publsihed to topic io.xconn.example")
}
func exampleRegister(session *xconn.Session) {
registration, err := session.Register("io.xconn.example", invocationHandler, map[string]any{})
if err != nil {
log.Fatalf("Failed to register: %v", err)
}
log.Printf("Registered procedure io.xconn.example: %v", registration)
}
func invocationHandler(ctx context.Context, inv *xconn.Invocation) (*xconn.Result, error) {
return &xconn.Result{Args: inv.Args, KwArgs: inv.KwArgs, Details: inv.Details}, nil
}
func exampleCall(session *xconn.Session) {
result, err := session.Call(context.Background(), "io.xconn.example", []any{"Hello World!"}, map[string]any{}, map[string]any{})
if err != nil {
log.Fatalf("Failed to call: %v", err)
}
log.Printf("Call result: args=%s, kwargs=%s, details=%s", result.Args, result.KwArgs, result.Details)
}
Authentication is straightforward. Simply create the desired authenticator and pass it to the Client.
Ticket Auth
ticketAuthenticator := auth.NewTicketAuthenticator(authID, map[string]any{}, ticket)
client := xconn.Client{Authenticator: ticketAuthenticator}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatalf("Failed to connect: %v", err)
}
Challenge Response Auth
craAuthenticator := auth.NewCRAAuthenticator(authID, map[string]any{}, secret)
client := xconn.Client{Authenticator: craAuthenticator}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatalf("Failed to connect: %v", err)
}
Cryptosign Auth
cryptoSignAuthenticator, err := auth.NewCryptoSignAuthenticator(authID, map[string]any{}, secret)
if err != nil {
log.Fatal(err)
}
client := xconn.Client{Authenticator: cryptoSignAuthenticator}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatalf("Failed to connect: %v", err)
}
XConn supports various serializers for different data formats. To use, just pass chosen serializer spec to the client.
JSON Serializer
client := xconn.Client{SerializerSpec: xconn.JSONSerializerSpec}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatalf("Failed to connect: %v", err)
}
CBOR Serializer
client := xconn.Client{SerializerSpec: xconn.CBORSerializerSpec}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatalf("Failed to connect: %v", err)
}
MsgPack Serializer
client := xconn.Client{SerializerSpec: xconn.MsgPackSerializerSpec}
session, err := client.Connect(context.Background(), "ws:https://localhost:8080/ws", "realm1")
if err != nil {
log.Fatalf("Failed to connect: %v", err)
}
For more detailed examples or usage, refer to the examples folder of the project.