newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Classes
WebSocket
chevron_left Classes
class
WebSocket

Constructors

functionsWebSocket

Properties

data_objectEnableCompressiondata_objectIsConnecteddata_objectSubProtocol

Methods

functionsAddSubProtocolfunctionsConnectfunctionsDisposefunctionsSend
WebSocket
A WebSocket client for connecting to external services.
class Sandbox .
sealedSandbox.Engine

Remarks

Events handlers will be called on the synchronization context that Connect was called on.

build Constructors 1

WebSocket (maxMessageSize)
Initialized a new WebSocket client.

data_object Properties 3

EnableCompression
bool
Enable or disable compression for the websocket. If the server supports it, compression will be enabled for all messages. Note: compression is disabled by default, and can be dangerous if you are sending secrets across the network.
IsConnected
bool
Returns true as long as a WebSocket connection is established.
SubProtocol
string
Get the sub-protocol that was negotiated during the opening handshake.

functions Methods 4

AddSubProtocol (protocol)
Add a sub-protocol to be negotiated during the WebSocket connection handshake.
Connect (websocketUri, ct)
Task
Establishes a connection to an external WebSocket service.
Dispose ()
Cleans up resources used by the WebSocket client. This will also immediately close the connection if it is currently open.
Send (message)
ValueTask
Sends a text message to the WebSocket server.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.