server

Documentation

Index

• type Options
• type Server
  • func New(options Options) (*Server, error)
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
  • func (s *Server) UpdateConfig(getToken types.GetToken, notificationConfig *client.NotificationConfig, ...) error
• type WebSocketMonitor
  • func CreateWebSocketMonitor(ctx *types.Context, options *monitorchannel.CreateWebSocketOptions) *WebSocketMonitor
  • func (m *WebSocketMonitor) Attach(server *http.Server)
  • func (m *WebSocketMonitor) OnTunnel(handler func(data map[string]interface{}))

Types

type Options

type Options struct {
	Version         string
	Domain          string
	Port            int
	TCPPort         int
	Secure          bool
	Token           types.GetToken
	Notification    *client.NotificationConfig
	BandwidthLimits *limiter.ClientBandwidthLimits
	// PublicHTTPNoAuthSessionTTL controls lifetime for HTTP tunnels without edge auth.
	// Zero means default 10m.
	PublicHTTPNoAuthSessionTTL time.Duration
	// PublicHTTPNoAuthWarnLeadTime controls warning lead time before the timeout.
	// Zero means default 2m.
	PublicHTTPNoAuthWarnLeadTime time.Duration
}

Options contains options for creating a server

type Server

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

Server represents the main server instance

func New

func New(options Options) (*Server, error)

New creates and initializes a new server instance

func (*Server) Start

func (s *Server) Start() error

Start starts the server

func (*Server) Stop

func (s *Server) Stop() error

Stop stops the server

func (*Server) UpdateConfig

func (s *Server) UpdateConfig(
	getToken types.GetToken,
	notificationConfig *client.NotificationConfig,
	bandwidthLimits *limiter.ClientBandwidthLimits,
	publicHTTPNoAuthSessionTTL time.Duration,
	publicHTTPNoAuthWarnLeadTime time.Duration,
) error

UpdateConfig updates the server configuration dynamically

type WebSocketMonitor

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

WebSocketMonitor manages WebSocket connections and authentication

func CreateWebSocketMonitor

func CreateWebSocketMonitor(ctx *types.Context, options *monitorchannel.CreateWebSocketOptions) *WebSocketMonitor

CreateWebSocketMonitor creates a new WebSocket monitor

func (*WebSocketMonitor) Attach

func (m *WebSocketMonitor) Attach(server *http.Server)

Attach attaches the WebSocket monitor to an HTTP server

func (*WebSocketMonitor) OnTunnel

func (m *WebSocketMonitor) OnTunnel(handler func(data map[string]interface{}))

OnTunnel registers a handler for tunnel events