sse

package

v1.8.0 Latest Latest Go to latest Published: Mar 16, 2024 License: MIT Imports: 5 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	// contains filtered or unexported fields
}

func (c *Client) Chan() chan Envelope

func (c *Client) ID() string

type Envelope interface {
	String() string // Represent the envelope contents as a string for transmission.
}

Envelope defines the interface for content that can be broadcast to clients.

type History interface {
	Add(message Envelope) // Add adds a message to the history.
	Send(c Listener)      // Send sends the history to a client.
}

type Listener interface {
	ID() string
	Chan() chan Envelope
}

Listener defines the interface for the receiving end.

func NewClient(id string) Listener

type Manager interface {
	Send(message Envelope)
	Handle(w http.ResponseWriter, r *http.Request, cl Listener)
	Clients() []string
}

Manager defines the interface for managing clients and broadcasting messages.

func NewManager(workerPoolSize int) Manager

NewManager initializes and returns a new Manager instance.

type Message struct {
	Event string
	Time  time.Time
	Data  string
}

Message represents a simple message implementation.

func NewMessage(data string) *Message

NewMessage returns a new message instance.

func (m *Message) String() string

String returns the message as a string.

func (m *Message) WithEvent(event string) Envelope

WithEvent sets the event name for the message.