diff options
Diffstat (limited to 'vendor/github.com/gin-contrib/sse/README.md')
| -rw-r--r-- | vendor/github.com/gin-contrib/sse/README.md | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/vendor/github.com/gin-contrib/sse/README.md b/vendor/github.com/gin-contrib/sse/README.md deleted file mode 100644 index cfe2c820b..000000000 --- a/vendor/github.com/gin-contrib/sse/README.md +++ /dev/null @@ -1,60 +0,0 @@ -# Server-Sent Events - -[](https://pkg.go.dev/github.com/gin-contrib/sse) -[](https://github.com/gin-contrib/sse/actions/workflows/go.yml) -[](https://codecov.io/gh/gin-contrib/sse) -[](https://goreportcard.com/report/github.com/gin-contrib/sse) - -Server-sent events (SSE) is a technology where a browser receives automatic updates from a server via HTTP connection. The Server-Sent Events EventSource API is [standardized as part of HTML5[1] by the W3C](http://www.w3.org/TR/2009/WD-eventsource-20091029/). - -- [Read this great SSE introduction by the HTML5Rocks guys](http://www.html5rocks.com/en/tutorials/eventsource/basics/) -- [Browser support](http://caniuse.com/#feat=eventsource) - -## Sample code - -```go -import "github.com/gin-contrib/sse" - -func httpHandler(w http.ResponseWriter, req *http.Request) { - // data can be a primitive like a string, an integer or a float - sse.Encode(w, sse.Event{ - Event: "message", - Data: "some data\nmore data", - }) - - // also a complex type, like a map, a struct or a slice - sse.Encode(w, sse.Event{ - Id: "124", - Event: "message", - Data: map[string]interface{}{ - "user": "manu", - "date": time.Now().Unix(), - "content": "hi!", - }, - }) -} -``` - -```sh -event: message -data: some data\\nmore data - -id: 124 -event: message -data: {"content":"hi!","date":1431540810,"user":"manu"} - -``` - -## Content-Type - -```go -fmt.Println(sse.ContentType) -``` - -```sh -text/event-stream -``` - -## Decoding support - -There is a client-side implementation of SSE coming soon. |