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
Connect
chevron_left Classes
class
WebSocket

Constructors

functionsWebSocket

Properties

data_objectEnableCompressiondata_objectIsConnecteddata_objectSubProtocol

Methods

functionsAddSubProtocolfunctionsConnectfunctionsDisposefunctionsSend
Connect
Establishes a connection to an external WebSocket service.
method2 overloads
Overloads
Task Connect (string websocketUri, CancellationToken ct)

Parameters

NameTypeDescription
websocketUri string The WebSocket URI to connect to. For example, "ws://hostname.local:1280/" for unencrypted WebSocket or "wss://hostname.local:1281/" for encrypted.
ct = null CancellationToken A which allows the connection attempt to be aborted if necessary.

Returns

TypeDescription
Task A which completes when the connection is established, or throws if it failed to connect.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.