Interface IWebSocket
Contract for an implementation of the WebSocket protocol v8.
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public interface IWebSocket
Properties
BufferedAmount
Gets the number of bytes buffered in the send queue.
Declaration
int BufferedAmount { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
IsOpen
Gets a value indicating whether the WebSocket is connected.
Declaration
bool IsOpen { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Secure
Gets a value indicating whether the WebSocket is secure.
Declaration
bool Secure { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
Close()
Closes the WebSocket connection.
Declaration
void Close()
Close(WebSocketCloseArgs)
Closes the WebSocket connection.
Declaration
void Close(WebSocketCloseArgs closeArgs)
Parameters
Type | Name | Description |
---|---|---|
WebSocketCloseArgs | closeArgs | The close arguments |
Open(WebSocketOpenArgs)
Opens the WebSocket connection.
Declaration
void Open(WebSocketOpenArgs openArgs)
Parameters
Type | Name | Description |
---|---|---|
WebSocketOpenArgs | openArgs | The open arguments. |
Send(WebSocketSendArgs)
Sends a message to the WebSocket server.
Declaration
void Send(WebSocketSendArgs sendArgs)
Parameters
Type | Name | Description |
---|---|---|
WebSocketSendArgs | sendArgs | The send arguments. |