devserver

Documentation

Index

• type BroadcastFunc
• type DevWebsockerServer
  • func NewDevWebsocketServer(options ...WebsocketServerSyncOption) *DevWebsockerServer
  • func (fw *DevWebsockerServer) Broadcast(message Message[any])
  • func (fw *DevWebsockerServer) Start() error
  • func (fw *DevWebsockerServer) Subscribe(subscriber Subscriber) func()
• type FileSyncMessage
• type FileSyncOption
  • func WithDebounce(debounce time.Duration) FileSyncOption
• type Message
• type NitricFileSync
  • func NewFileSync(filePath string, broadcast BroadcastFunc, options ...FileSyncOption) (*NitricFileSync, error)
  • func (fs *NitricFileSync) Close() error
  • func (fs *NitricFileSync) OnConnect(send SendFunc)
  • func (fs *NitricFileSync) OnMessage(message json.RawMessage)
  • func (fs *NitricFileSync) Start() error
• type SendFunc
• type Subscriber
• type WebsocketServerSyncOption
  • func WithListener(listener net.Listener) WebsocketServerSyncOption

Types

type BroadcastFunc

type BroadcastFunc func(Message[any])

type DevWebsockerServer

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

DevWebsockerServer manages WebSocket connections and file watching

func NewDevWebsocketServer

func NewDevWebsocketServer(options ...WebsocketServerSyncOption) *DevWebsockerServer

NewDevWebsocketServer creates a Websocket file syncing service

func (*DevWebsockerServer) Broadcast

func (fw *DevWebsockerServer) Broadcast(message Message[any])

Broadcast a message to connected clients

func (*DevWebsockerServer) Start

func (fw *DevWebsockerServer) Start() error

Start starts the WebSocket server and file watcher

func (*DevWebsockerServer) Subscribe

func (fw *DevWebsockerServer) Subscribe(subscriber Subscriber) func()

type FileSyncMessage

type FileSyncMessage Message[schema.Application]

type FileSyncOption

type FileSyncOption func(*NitricFileSync)

func WithDebounce

func WithDebounce(debounce time.Duration) FileSyncOption

type Message

type Message[T any] struct {
	Type    string `json:"type"`
	Payload T      `json:"payload"`
}

type NitricFileSync

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

func NewFileSync

func NewFileSync(filePath string, broadcast BroadcastFunc, options ...FileSyncOption) (*NitricFileSync, error)

func (*NitricFileSync) Close

func (fs *NitricFileSync) Close() error

func (*NitricFileSync) OnConnect

func (fs *NitricFileSync) OnConnect(send SendFunc)

func (*NitricFileSync) OnMessage

func (fs *NitricFileSync) OnMessage(message json.RawMessage)

func (*NitricFileSync) Start

func (fs *NitricFileSync) Start() error

type SendFunc

type SendFunc func(message Message[any])

type Subscriber

type Subscriber interface {
	OnMessage(message json.RawMessage)
	// Provide a function reference that allows the subscriber to send messages to the newly connected client
	OnConnect(send SendFunc)
}

type WebsocketServerSyncOption

type WebsocketServerSyncOption func(*DevWebsockerServer)

Implement additional constructor options

func WithListener

func WithListener(listener net.Listener) WebsocketServerSyncOption