API reference
API reference
Select your platform
No SDKs available
No versions available

IWebSocket Interface

An interface for a WebSocket wrapper class

Overview

Properties

State[Get]
The current state of the web socket client

Events

Action
OnOpen ( )
Callback when web socket is opened
Action< byte[]>
Callback when message is received from web socket server
Action< string >
OnError ( )
Callback when an error is received from web socket server
OnClose ( )
Callback when message is received from web socket server

Public Member Functions

Task
Connect ( )
Method to begin web socket communication
Task
Send
( byte [] data )
Method to send byte data to a web socket
Task
Close ( )
Method to close web socket communication with normal close code

Details

Properties

WitWebSocketConnectionState Meta.Voice.Net.WebSockets.IWebSocket.State
The current state of the web socket client

Events

Action Meta.Voice.Net.WebSockets.IWebSocket.OnOpen ( )
Callback when web socket is opened
Action<byte[]> Meta.Voice.Net.WebSockets.IWebSocket.OnMessage ( )
Callback when message is received from web socket server
Action<string> Meta.Voice.Net.WebSockets.IWebSocket.OnError ( )
Callback when an error is received from web socket server
Action<WebSocketCloseCode> Meta.Voice.Net.WebSockets.IWebSocket.OnClose ( )
Callback when message is received from web socket server

Member Functions

Task Meta.Voice.Net.WebSockets.IWebSocket.Connect ( )
Method to begin web socket communication
Task Meta.Voice.Net.WebSockets.IWebSocket.Send
( byte [] data )
Method to send byte data to a web socket
Task Meta.Voice.Net.WebSockets.IWebSocket.Close ( )
Method to close web socket communication with normal close code
Did you find this page helpful?
Thumbs up icon
Thumbs down icon