Class WebSocketServer

WebSocket server that listens on a local address and accepts incoming client connections from web content or other plugins.

Hierarchy (View Summary)

BaseServer
- WebSocketServer

Index

Constructors

Properties

address onConnect onError port

Methods

close create getTypeName isOfType isSame listen

Constructors

`Protected`constructor

new WebSocketServer(): WebSocketServer
Snap Hidden
Returns WebSocketServer
Overrides BaseServer.constructor

Properties

`Readonly`address

address: string

The address string the server is currently bound to.

`Readonly`onConnect

onConnect: signal1<BaseSocket, void>

Signal fired when a new client socket connects to the server.

`Readonly`onError

onError: signal1<number, void>

Signal fired when a server error occurs, passing an error code.

`Readonly`port

port: number

Methods

close

close(): void
Closes the server and stops accepting new connections.

Returns void
Inherited from BaseServer.close

`Static`create

create(): WebSocketServer
Creates and returns a new WebSocketServer instance.

Returns WebSocketServer

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from BaseServer.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from BaseServer.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from BaseServer.isSame

listen

listen(address: Address): boolean
Starts listening for incoming connections on the specified address; returns true if successful.
Parameters
- address: Address
Returns boolean
Inherited from BaseServer.listen