Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kataras/neffos
A modern, fast and scalable websocket framework with elegant API written in Go
https://github.com/kataras/neffos
go golang iris neffos websocket
Last synced: 5 days ago
JSON representation
A modern, fast and scalable websocket framework with elegant API written in Go
- Host: GitHub
- URL: https://github.com/kataras/neffos
- Owner: kataras
- License: mit
- Created: 2019-02-20T02:10:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T17:28:16.000Z (8 months ago)
- Last Synced: 2024-05-02T05:25:41.617Z (7 months ago)
- Topics: go, golang, iris, neffos, websocket
- Language: Go
- Homepage: http://bit.ly/neffos-wiki
- Size: 1.17 MB
- Stars: 563
- Watchers: 16
- Forks: 48
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
- go-awesome - neffos - A fast and extensible WebSocket framework (Open source library / WebSocket)
README
[](https://github.com/neffos-contrib/bootstrap-chat)
[](https://github.com/kataras/neffos/actions) [](https://goreportcard.com/report/github.com/kataras/neffos) [](https://github.com/kataras/neffos/tree/master/_examples) [](https://gitter.im/neffos-framework/community) [](https://github.com/kataras/neffos.js)
## About neffos
Neffos is a cross-platform real-time framework with expressive, elegant API written in [Go](https://go.dev). Neffos takes the pain out of development by easing common tasks used in real-time backend and frontend applications such as:
- Scale-out using redis or nats[*](_examples/scale-out)
- Adaptive request upgradation and server dialing
- Acknowledgements
- Namespaces
- Rooms
- Broadcast
- Event-Driven architecture
- Request-Response architecture
- Error Awareness
- Asynchronous Broadcast
- Timeouts
- Encoding
- Reconnection
- Modern neffos API client for Browsers, Nodejs[*](https://github.com/kataras/neffos.js) and Go
## Learning neffos
Quick View
## Server
```go
import (
// [...]
"github.com/kataras/neffos"
"github.com/kataras/neffos/gorilla"
)
func runServer() {
events := make(neffos.Namespaces)
events.On("/v1", "workday", func(ns *neffos.NSConn, msg neffos.Message) error {
date := string(msg.Body)
t, err := time.Parse("01-02-2006", date)
if err != nil {
if n := ns.Conn.Increment("tries"); n >= 3 && n%3 == 0 {
// Return custom error text to the client.
return fmt.Errorf("Why not try this one? 06-24-2019")
} else if n >= 6 && n%2 == 0 {
// Fire the "notify" client event.
ns.Emit("notify", []byte("What are you doing?"))
}
// Return the parse error back to the client.
return err
}
weekday := t.Weekday()
if weekday == time.Saturday || weekday == time.Sunday {
return neffos.Reply([]byte("day off"))
}
// Reply back to the client.
responseText := fmt.Sprintf("it's %s, do your job.", weekday)
return neffos.Reply([]byte(responseText))
})
websocketServer := neffos.New(gorilla.DefaultUpgrader, events)
// Fire the "/v1:notify" event to all clients after server's 1 minute.
time.AfterFunc(1*time.Minute, func() {
websocketServer.Broadcast(nil, neffos.Message{
Namespace: "/v1",
Event: "notify",
Body: []byte("server is up and running for 1 minute"),
})
})
router := http.NewServeMux()
router.Handle("/", websocketServer)
log.Println("Serving websockets on localhost:8080")
log.Fatal(http.ListenAndServe(":8080", router))
}
```
## Go Client
```go
func runClient() {
ctx := context.TODO()
events := make(neffos.Namespaces)
events.On("/v1", "notify", func(c *neffos.NSConn, msg neffos.Message) error {
log.Printf("Server says: %s\n", string(msg.Body))
return nil
})
// Connect to the server.
client, err := neffos.Dial(ctx,
gorilla.DefaultDialer,
"ws://localhost:8080",
events)
if err != nil {
panic(err)
}
// Connect to a namespace.
c, err := client.Connect(ctx, "/v1")
if err != nil {
panic(err)
}
fmt.Println("Please specify a date of format: mm-dd-yyyy")
for {
fmt.Print(">> ")
var date string
fmt.Scanf("%s", &date)
// Send to the server and wait reply to this message.
response, err := c.Ask(ctx, "workday", []byte(date))
if err != nil {
if neffos.IsCloseError(err) {
// Check if the error is a close signal,
// or make use of the `<- client.NotifyClose`
// read-only channel instead.
break
}
// >> 13-29-2019
// error received: parsing time "13-29-2019": month out of range
fmt.Printf("error received: %v\n", err)
continue
}
// >> 06-29-2019
// it's a day off!
//
// >> 06-24-2019
// it's Monday, do your job.
fmt.Println(string(response.Body))
}
}
```
## Javascript Client
Navigate to:
Neffos contains extensive and thorough **[wiki](https://github.com/kataras/neffos/wiki)** making it easy to get started with the framework.
For a more detailed technical documentation you can head over to our [godocs](https://godoc.org/github.com/kataras/neffos). And for executable code you can always visit the [_examples](_examples/) repository's subdirectory.
### Do you like to read while traveling?
You can [download](https://www.iris-go.com/neffos-book.pdf) a PDF version of the **E-Book** today and be participated in the development of neffos.
[](https://www.iris-go.com/neffos-book.pdf)
## Contributing
We'd love to see your contribution to the neffos real-time framework! For more information about contributing to the neffos project please check the [CONTRIBUTING.md](CONTRIBUTING.md) file.
- [neffos-contrib](https://github.com/neffos-contrib) github organisation for more programming languages support, please invite yourself.
## Security Vulnerabilities
If you discover a security vulnerability within neffos, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
## License
The word "neffos" has a greek origin and it is translated to "cloud" in English dictionary.
This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).