Skip to content
forked from manucorporat/sse

Server-Sent Events implementation in Go. Used by the Gin Framework.

License

Notifications You must be signed in to change notification settings

gin-contrib/sse

 
 

Repository files navigation

Server-Sent Events

Go Reference Run Tests codecov Go Report Card

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.

Sample code

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!",
    },
  })
}
event: message
data: some data\\nmore data

id: 124
event: message
data: {"content":"hi!","date":1431540810,"user":"manu"}

Content-Type

fmt.Println(sse.ContentType)
text/event-stream

Decoding support

There is a client-side implementation of SSE coming soon.

About

Server-Sent Events implementation in Go. Used by the Gin Framework.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%