The WebSocketClient type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
  | WebSocketClient |
Creates a new instance of WebSocketClient.
|
Methods
| Name | Description | |
|---|---|---|
| Abort |
Aborts the WebSocket and all active operations.
|
| Close()()()() |
Closes the sending part of the WebSocket (unless already closed) and waits for the receiving part to be closed.
|
| Close(WebSocketCloseStatus, String) |
Closes the sending part of the WebSocket (unless already closed) and waits for the receiving part to be closed.
|
| CloseOutput |
Closes the sending part of the WebSocket, making it possible to still receive messages from the server.
|
| Connect(String) |
Establish a WebSocket connection to the specified URL.
|
| Connect(Uri) |
Establish a WebSocket connection to the specified URL.
|
| Dispose |
Disposes the WebSocketClient object and the underlying connection.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Poll |
Wait until a message fragment is received or the specified timout has elapsed.
|
| Receive(ArraySegment<(Of <<'(Byte>)>>)) |
Receives a message fragment from the server.
|
| Receive<(Of <<'(T>)>>)()()()() |
Receives a message of the specified type from the server. Only String, byte array and Object types are currently supported.
|
| Send(array<Byte>[]()[][]) |
Sends the specified binary message to the server.
|
| Send(String) |
Sends the specified text message to the server.
|
| Send(ArraySegment<(Of <<'(Byte>)>>), WebSocketMessageType, Boolean) |
Sends the specified message fragment to the server.
|
| SetSocketFactory |
Sets the socket factory to be used to create communication sockets.
|
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | CloseStatus |
Gets the close status (only available once the WebSocket has been closed).
|
| CloseStatusDescription |
Gets the close status description (only available once the WebSocket has been closed).
|
 | InstanceId |
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.) |
| IsAuthenticated | (Overrides NetworkSession..::..IsAuthenticated.) |
| IsConnected | (Overrides NetworkSession..::..IsConnected.) |
| LogWriter |
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.) |
| Options |
WebSocket options.
|
| Proxy |
Gets or sets the network proxy to use to access a remote server.
|
| ServerName |
Gets the server name, if available.
(Inherited from NetworkSession.) |
| ServerPort |
Gets the server port, if available.
(Inherited from NetworkSession.) |
| Settings |
Gets an WebSocketClientSettings object.
|
| State |
Gets the last known state of the WebSocket object.
|
| SubProtocol |
Gets the sub-protocol selected by the server (only available once the WebSocket has been connected).
|
| UserName |
Gets the authenticated user name, if available.
(Inherited from NetworkSession.) |
Events
| Name | Description | |
|---|---|---|
 | ValidatingCertificate |
Occurs when a server certificate needs to be validated.
|
See Also
