websocket

package

v0.40.0 Latest Latest Go to latest Published: Nov 13, 2026 License: MIT Imports: 12 Imported by: 0

Details

Package websocket provides the scriptling.net.websocket client library.

View Source

const LibraryName = "scriptling.net.websocket"

LibraryName is the script-visible name of the WebSocket client library.

View Source

var WebSocketLibrary = newWebSocketLibrary(nil)

WebSocketLibrary is the WebSocket client library (no network policy)

func Register(registrar interface{ RegisterLibrary(*object.Library) }, cfg ...*netsecurity.Config)

Register registers the WebSocket client library. An optional network policy guards the outbound dial.

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

WebSocketClientConn wraps a websocket.Conn with thread-safe access

func NewWebSocketClientConn(conn *websocket.Conn) *WebSocketClientConn

NewWebSocketClientConn creates a new wrapped WebSocket connection

func (c *WebSocketClientConn) Close() error

Close closes the connection

func (c *WebSocketClientConn) ClosedChan() <-chan struct{}

ClosedChan returns a channel that closes when the connection closes

func (c *WebSocketClientConn) IsConnected() bool

IsConnected returns whether the connection is still open

func (c *WebSocketClientConn) ReadWithTimeout(timeout time.Duration) (int, []byte, error)

ReadWithTimeout reads a message with a timeout Returns messageType, data, error. On timeout, returns 0, nil, nil

func (c *WebSocketClientConn) RemoteAddr() string

RemoteAddr returns the remote address

func (c *WebSocketClientConn) WriteMessage(msgType int, data []byte) error

WriteMessage sends a message