gsse

Documentation

Index

• Constants
• func Handle(fn func(*Client)) func(*ghttp.Request)
• type Client
  • func (c *Client) Close()
  • func (c *Client) Context() context.Context
  • func (c *Client) KeepAlive()
  • func (c *Client) OnClose(fn func(*Client))
  • func (c *Client) Request() *ghttp.Request
  • func (c *Client) Response() *ghttp.Response
  • func (c *Client) SendComment(comment string)
  • func (c *Client) SendEvent(event, data string)
  • func (c *Client) SendEventWithId(event, data, id string)
  • func (c *Client) SendMessage(data string)
  • func (c *Client) SendMessageWithId(data, id string)
  • func (c *Client) Terminated() bool

Constants

const (
	NoEvent      = ""
	NoId         = ""
	EmptyComment = ""
)

Functions

func Handle

func Handle(fn func(*Client)) func(*ghttp.Request)

Handle wraps func(*gsse.Client) to func(*ghttp.Request), use by ghttp.Server.BindHandler().

Types

type Client

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

Client wraps the SSE(Server-Sent Event) ghttp.Request and provides SSE APIs

func (*Client) Close

func (c *Client) Close()

Close closes the connection

func (*Client) Context

func (c *Client) Context() context.Context

Context is alias for ghttp.Request.Context().

func (*Client) KeepAlive

func (c *Client) KeepAlive()

KeepAlive keeps the connection alive, if you need to use the client outside the handler

func (*Client) OnClose

func (c *Client) OnClose(fn func(*Client))

OnClose callback which runs when a client closes its connection

func (*Client) Request

func (c *Client) Request() *ghttp.Request

Request return ghttp.Request.

func (*Client) Response

func (c *Client) Response() *ghttp.Response

Response is alias for ghttp.Request.Response.

func (*Client) SendComment

func (c *Client) SendComment(comment string)

SendComment send comment with prefix":"

func (*Client) SendEvent

func (c *Client) SendEvent(event, data string)

SendEvent calls emit("event", "data", noId)

func (*Client) SendEventWithId

func (c *Client) SendEventWithId(event, data, id string)

SendEventWithId calls emit("event", "data", "id")

func (*Client) SendMessage

func (c *Client) SendMessage(data string)

SendMessage calls emit(noEvent, "data", noId)

func (*Client) SendMessageWithId

func (c *Client) SendMessageWithId(data, id string)

SendMessageWithId calls emit(noEvent, "data", "id")

func (*Client) Terminated

func (c *Client) Terminated() bool

Terminated returns true if the connection has been closed