Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lampctl/go-sse
Go package for sending and receiving SSE (server-sent events)
https://github.com/lampctl/go-sse
Last synced: about 2 months ago
JSON representation
Go package for sending and receiving SSE (server-sent events)
- Host: GitHub
- URL: https://github.com/lampctl/go-sse
- Owner: lampctl
- License: mit
- Created: 2022-12-28T02:43:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-21T04:40:03.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:52:36.235Z (4 months ago)
- Language: Go
- Size: 41 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-go - go-sse - Go client and server implementation of HTML server-sent events. (Networking / Transliteration)
- zero-alloc-awesome-go - go-sse - Go client and server implementation of HTML server-sent events. (Networking / Transliteration)
README
## go-sse
[](https://github.com/lampctl/go-sse/actions/workflows/test.yml)
[](https://coveralls.io/github/lampctl/go-sse?branch=main)
[](https://goreportcard.com/report/github.com/lampctl/go-sse)
[](https://pkg.go.dev/github.com/lampctl/go-sse)
[](https://opensource.org/licenses/MIT)
This package attempts to provide a robust and reliable implementation of [server-sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#concept-event-stream-reconnection-time). One might use this package if they were writing an application that needed to connect to an SSE server endpoint and read events in a continuous stream or provide events to a front-end service.
### Features
Here's what you get with this package:
- Complete documentation for every last type and method in the package
- Compliancy with section 9.2 of the WHATWG HTML specification
- Extensive test suite to ensure conformance
go-sse requires a minimum of **Go 1.18**.
### Basic Usage
To use the package in your application, begin by importing it:
```golang
import "github.com/lampctl/go-sse"
```
### Use as a Client
Create a client using:
```golang
c, err := sse.NewClientFromURL("http://example.com/sse")
if err != nil {
// ...
}
```
You can now read events directly from the `c.Events` channel as they are received:
```golang
for e := range c.Events {
fmt.Println("Event received!")
fmt.Println(e.Data)
}
```
> Note that if the connection is closed or interrupted, the client will attempt to reconnect as per the spec and continue returning events from where it was interrupted. This is all handled behind the scenes and won't affect the status of the event channel.
When you are done receiving events, close the client:
```golang
c.Close()
```
### Use as a Server
The server component is provided via `Handler`, which implements `http.Handler`:
```golang
h := sse.NewHandler(nil)
// ...or if you want to customize initialization:
h := sse.NewHandler(&sse.HandlerConfig{
NumEventsToKeep: 10,
ChannelBufferSize: 4,
})
```
To send an event, simply use the `Send()` method:
```golang
h.Send(&sse.Event{
Type: "alert",
Data: "The aliens are invading!",
ID: "12345",
})
```
When you are done, use the `Close()` method:
```golang
h.Close()
```