 | WebSocketMessageReader Class |
[This is preliminary documentation and is subject to change.]
A MessageReader implementation that reads JSON-RPC message from WebSocket.
Inheritance HierarchySystemObject
JsonRpc.StreamsMessageReader
JsonRpc.StreamsQueuedMessageReader
JsonRpc.WebSocketsWebSocketMessageReader
JsonRpc.StreamsMessageReader
JsonRpc.StreamsQueuedMessageReader
JsonRpc.WebSocketsWebSocketMessageReader
Namespace: JsonRpc.WebSockets
Assembly: JsonRpc.WebSockets (in JsonRpc.WebSockets.dll) Version: 0.5.4+1bad715934a0ae5922832940ca44bbbdaa509cfe
SyntaxThe WebSocketMessageReader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WebSocketMessageReader(WebSocket) | Initializes a new instance of the WebSocketMessageReader class |
| WebSocketMessageReader(WebSocket, Int32, Int32) |
Initializes a message reader from WebSocket.
|
Properties| Name | Description | |
|---|---|---|
 | DisposalToken |
A CancellationToken that is cancelled when the current object has been disposed.
(Inherited from MessageReader.) |
 | WebSocket |
Gets the underlying WebSocket.
|
| WebSocketClose |
Gets a Task that completes with status code when the underlying WebSocket is closed.
|
Methods| Name | Description | |
|---|---|---|
 | DeserializeMessage |
Loads a JSON-RPC message from the specified stream.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from MessageReader.) |
| Dispose(Boolean) | (Inherited from QueuedMessageReader.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (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.) |
| ReadAsync |
Asynchronously reads the next message that matches the
(Inherited from QueuedMessageReader.) |
| ReadDirectAsync |
When overridden in the derived class, directly asynchronously reads the next message.
(Overrides QueuedMessageReaderReadDirectAsync(CancellationToken).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
You can use this class with StreamRpcServerHandler or StreamRpcClientHandler.
See Also