websocket

Documentation

Index

• type Error
• type OperationParameters
• type PayloadMetadata
• type WebSocketHandler
  • func NewWebSocketHandler(thunder *thunder.Thunder) *WebSocketHandler
  • func (h *WebSocketHandler) HandlerFunc() http.HandlerFunc
• type WebSocketMessage
• type WebSocketOperation

Types

type Error

type Error struct {
	Message string `json:"message"`
}

type OperationParameters

type OperationParameters struct {
	Query store.Query `json:"query"`
	Limit store.Limit `json:"limit"`
	Order store.Order `json:"offset"`
}

type PayloadMetadata

type PayloadMetadata struct {
	Exists bool `json:"exists"`
}

type WebSocketHandler

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

func NewWebSocketHandler

func NewWebSocketHandler(thunder *thunder.Thunder) *WebSocketHandler

func (*WebSocketHandler) HandlerFunc

func (h *WebSocketHandler) HandlerFunc() http.HandlerFunc

type WebSocketMessage

type WebSocketMessage struct {
	Operation           WebSocketOperation  `json:"operation"`
	OperationParameters OperationParameters `json:"operationParameters,omitempty"`
	Key                 string              `json:"key"`
	RequestID           uint64              `json:"requestId"`
	TransactionID       uint64              `json:"transactionId"`
	Error               Error               `json:"error"`
	Payload             json.RawMessage     `json:"payload,omitempty"`
	PayloadMetadata     PayloadMetadata     `json:"payloadMetadata,omitempty"`
}

type WebSocketOperation

type WebSocketOperation string

const (
	// Incoming
	Subscribe WebSocketOperation = "SUBSCRIBE"
	Add       WebSocketOperation = "ADD"
	Set       WebSocketOperation = "SET"
	Update    WebSocketOperation = "UPDATE"
	Delete    WebSocketOperation = "DELETE"

	// Outgoing
	ValueChange WebSocketOperation = "VALUE_CHANGE"

	// Incoming & Outgoing
	Snapshot WebSocketOperation = "SNAPSHOT"
)