stream

Documentation

Index

• type API
  • func New(pingPeriod, pongTimeout time.Duration, allowedWebSocketOrigins []string) *API
  • func (a *API) Close()
  • func (a *API) CollectConnectedClientTokens() []string
  • func (a *API) Handle(ctx *gin.Context)
  • func (a *API) Notify(userID uint, msg *model.MessageExternal)
  • func (a *API) NotifyDeletedClient(userID uint, token string)
  • func (a *API) NotifyDeletedUser(userID uint) error

Types

type API

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

The API provides a handler for a WebSocket stream API.

func New

func New(pingPeriod, pongTimeout time.Duration, allowedWebSocketOrigins []string) *API

New creates a new instance of API. pingPeriod: is the interval, in which is server sends the a ping to the client. pongTimeout: is the duration after the connection will be terminated, when the client does not respond with the pong command.

func (*API) Close

func (a *API) Close()

Close closes all client connections and stops answering new connections.

func (*API) CollectConnectedClientTokens

func (a *API) CollectConnectedClientTokens() []string

CollectConnectedClientTokens returns all tokens of the connected clients.

func (*API) Handle

func (a *API) Handle(ctx *gin.Context)

Handle handles incoming requests. First it upgrades the protocol to the WebSocket protocol and then starts listening for read and writes. swagger:operation GET /stream message streamMessages

Websocket, return newly created messages.

---
schema: ws, wss
produces: [application/json]
security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []]
responses:
  200:
    description: Ok
    schema:
        $ref: "#/definitions/Message"
  400:
    description: Bad Request
    schema:
        $ref: "#/definitions/Error"
  401:
    description: Unauthorized
    schema:
        $ref: "#/definitions/Error"
  403:
    description: Forbidden
    schema:
        $ref: "#/definitions/Error"
  500:
    description: Server Error
    schema:
        $ref: "#/definitions/Error"

func (*API) Notify

func (a *API) Notify(userID uint, msg *model.MessageExternal)

Notify notifies the clients with the given userID that a new messages was created.

func (*API) NotifyDeletedClient

func (a *API) NotifyDeletedClient(userID uint, token string)

NotifyDeletedClient closes existing connections with the given token.

func (*API) NotifyDeletedUser

func (a *API) NotifyDeletedUser(userID uint) error

NotifyDeletedUser closes existing connections for the given user.