Home

Welcome to neffos - a lightweight real-time framework based on WebSockets for Go.

This wiki is the main source of documentation for developers working with (or contributing to) the neffos project.

Getting started

• Installation
• Getting Started
• Architecture
• Examples
• What's new in v0.0.25

Concepts

• Upgraders and Dialers
• Namespaces
• Rooms
• Broadcast
• Wait for response
• Struct handlers
• Connections

Messaging

• Encoding
• Binary messages
• Protobufs
• Native Websocket Messages
• Errors

Production

• Authentication
• Timeouts
• Reconnection
• Close codes and shutdown
• Debugging

Scale out

• Scale out
• Choosing a backend
• Scale out using Redis
• Scale out using Nats
• Writing a custom StackExchange

neffos v0.0.25 adds close codes and a heartbeat, a message size limit, Conn.Send, Server.Shutdown, a coder backend, and a redis stack exchange on go-redis. It requires Go 1.27 and uses its generic methods (msg.As[T](), c.Conn.Value[T](key), c.AskObject[Reply](...), Struct[T]) and encoding/json/v2; a few v0.0.x signatures change, listed in a table on the migration page. The JavaScript client, neffos.js, moves to 0.3.0 with ESM, CJS and global builds and built-in reconnect. See What's new in v0.0.25 for the full list, two-line snippets of the new API, and an old-to-new example path table.