gows

Documentation

Index

• func GinLogger(logger loggerEntryWithFields, timeFormat string, utc bool) gin.HandlerFunc
• func ServeWs(hub *Hub, w http.ResponseWriter, r *http.Request, ...)
• type Client
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Broadcast(bytes []byte)
  • func (h *Hub) Run(closeOnNobody bool)
  • func (h *Hub) Unicast(msg *UnicastMessage)
• type UnicastMessage

Functions

func GinLogger

func GinLogger(logger loggerEntryWithFields, timeFormat string, utc bool) gin.HandlerFunc

Ginrus returns a gin.HandlerFunc (middleware) that logs requests using logrus.

Requests with errors are logged using logrus.Error(). Requests without errors are logged using logrus.Info().

It receives:

1. A time package format string (e.g. time.RFC3339).
2. A boolean stating whether to use UTC time zone or local.

func ServeWs

func ServeWs(hub *Hub, w http.ResponseWriter, r *http.Request, messageHandler func(client *Client, bytes []byte))

ServeWs handles websocket requests from the peer.

Types

type Client

type Client struct {

	// The websocket connection.
	Conn *websocket.Conn
	// contains filtered or unexported fields
}

Client is a middleman between the websocket connection and the hub.

type Hub

type Hub struct {
	Status int
	// contains filtered or unexported fields
}

Hub maintains the set of active clients and broadcasts messages to the clients.

func NewHub

func NewHub() *Hub

func (*Hub) Broadcast

func (h *Hub) Broadcast(bytes []byte)

func (*Hub) Run

func (h *Hub) Run(closeOnNobody bool)

func (*Hub) Unicast

func (h *Hub) Unicast(msg *UnicastMessage)

type UnicastMessage

type UnicastMessage struct {
	Client  *Client
	Message []byte
}