websockets

Documentation

Index

• type Client
• type Config
• type Message
• type MessageHandler
• type Server
  • func NewServer(ctx context.Context, opts ...ServerOption) *Server
  • func (server *Server) AgentPing(agentTarget *types.Target) bool
  • func (server *Server) AgentVersion(agentTarget *types.Target) string
  • func (s *Server) GetClientVersion(clientID string) string
  • func (s *Server) IsClientConnected(clientID string) bool
  • func (s *Server) RegisterHandler(msgType string, handler MessageHandler) UnregisterFunc
  • func (s *Server) SendToClient(clientID string, msg Message) error
  • func (s *Server) ServeWS(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Shutdown(ctx context.Context) error
• type ServerOption
  • func WithWorkerPoolSize(size int) ServerOption
• type UnregisterFunc
• type WSClient
  • func NewWSClient(ctx context.Context, config Config) (*WSClient, error)
  • func (c *WSClient) Close() error
  • func (c *WSClient) Connect(ctx context.Context) error
  • func (c *WSClient) GetConnectionStatus() bool
  • func (c *WSClient) RegisterHandler(msgType string, handler MessageHandler) UnregisterFunc
  • func (c *WSClient) Send(ctx context.Context, msg Message) error
• type WorkerPool
  • func NewWorkerPool(size int) *WorkerPool
  • func (p *WorkerPool) Submit(ctx context.Context, task func()) error
  • func (p *WorkerPool) Wait()

Types

type Client

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

type Config

type Config struct {
	ServerURL string
	ClientID  string
	Headers   http.Header
	TLSConfig *tls.Config
}

type Message

type Message struct {
	ClientID string    `json:"client_id"`
	Type     string    `json:"type"`
	Content  string    `json:"content"`
	Time     time.Time `json:"time"`
}

type MessageHandler

type MessageHandler func(ctx context.Context, msg *Message) error

type Server

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

func NewServer

func NewServer(ctx context.Context, opts ...ServerOption) *Server

func (*Server) AgentPing

func (server *Server) AgentPing(agentTarget *types.Target) bool

func (*Server) AgentVersion

func (server *Server) AgentVersion(agentTarget *types.Target) string

func (*Server) GetClientVersion

func (s *Server) GetClientVersion(clientID string) string

func (*Server) IsClientConnected

func (s *Server) IsClientConnected(clientID string) bool

func (*Server) RegisterHandler

func (s *Server) RegisterHandler(msgType string, handler MessageHandler) UnregisterFunc

func (*Server) SendToClient

func (s *Server) SendToClient(clientID string, msg Message) error

func (*Server) ServeWS

func (s *Server) ServeWS(w http.ResponseWriter, r *http.Request)

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

type ServerOption

type ServerOption func(*Server)

func WithWorkerPoolSize

func WithWorkerPoolSize(size int) ServerOption

type UnregisterFunc

type UnregisterFunc func()

type WSClient

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

func NewWSClient

func NewWSClient(ctx context.Context, config Config) (*WSClient, error)

func (*WSClient) Close

func (c *WSClient) Close() error

func (*WSClient) Connect

func (c *WSClient) Connect(ctx context.Context) error

func (*WSClient) GetConnectionStatus

func (c *WSClient) GetConnectionStatus() bool

func (*WSClient) RegisterHandler

func (c *WSClient) RegisterHandler(msgType string, handler MessageHandler) UnregisterFunc

func (*WSClient) Send

func (c *WSClient) Send(ctx context.Context, msg Message) error

type WorkerPool

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

func NewWorkerPool

func NewWorkerPool(size int) *WorkerPool

func (*WorkerPool) Submit

func (p *WorkerPool) Submit(ctx context.Context, task func()) error

func (*WorkerPool) Wait

func (p *WorkerPool) Wait()