websocket

Documentation

Index

• Constants
• Variables
• type Client
• type Listener
• type Message
• type WebSocket
  • func New(lenChan int, clientMaxCount ...int) WebSocket

Constants

const (
	NewClientListenerType          = "new-client"
	NewClientSessionListenerType   = "new-client-session"
	CloseClientListenerType        = "close-client"
	CloseClientSessionListenerType = "close-client-session"
	NewMessageListenerType         = "new-message"
)

Variables

var (
	ErrMaxCountSessions = apperr.New("max_count_sessions",
		apperr.WithTextTranslate(translator.Translate{translator.RU: "Превышено максимальное количество сессий", translator.EN: "Maximum number of sessions exceeded"}),
		apperr.WithCode(code.Unauthenticated))
)

var (
	MaxMessageSize int64 = 512
)

Types

type Client

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

type Listener

type Listener struct {
	Event     string
	Message   []byte
	ClientID  int
	SessionID string
}

type Message

type Message struct {
	Type          string      `json:"type"`
	Action        string      `json:"action"`
	Message       interface{} `json:"message"`
	From          *int        `json:"from,omitempty"`
	To            []int       `json:"to,omitempty"`
	ToSession     *string     `json:"to_session,omitempty"`
	ExceptSession *string     `json:"except_session,omitempty"`
	ContentType   int         `json:"-"`
}

type WebSocket

type WebSocket interface {
	InitHandler(api *gin.RouterGroup)
	SendMessage(ctx context.Context, m Message) error
	RegisterClientListener() <-chan Listener
	ShutDown()
}

func New

func New(lenChan int, clientMaxCount ...int) WebSocket