WebSocketStream
Adapts a WebSocket to a bidirectional Stream, allowing TelnetFraming to operate over WebSocket connections. Binary messages are read/written as a flat byte stream.
- Kind:
Class - Namespace: Repl.Telnet
- Assembly:
Repl.Telnet - Source: src/Repl.Telnet/WebSocketStream.cs
Signature
Section titled “Signature”public sealed class WebSocketStream : Stream, IAsyncDisposable, IDisposableInheritance
Section titled “Inheritance”Implements
Section titled “Implements”Constructors
Section titled “Constructors”WebSocketStream(WebSocket, CancellationToken)
Section titled “WebSocketStream(WebSocket, CancellationToken)”Wraps the specified WebSocket as a stream.
public WebSocketStream(WebSocket socket, CancellationToken ct = default)Parameters
Section titled “Parameters”socket(WebSocket): An open binary WebSocket.ct(CancellationToken): Cancellation token for the lifetime of the stream.
Methods
Section titled “Methods”Flush()
Section titled “Flush()”When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
public override void Flush()FlushAsync(CancellationToken)
Section titled “FlushAsync(CancellationToken)”Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
public override Task FlushAsync(CancellationToken cancellationToken)Parameters
Section titled “Parameters”cancellationToken(CancellationToken): The token to monitor for cancellation requests. The default value is None.
Returns
Section titled “Returns”Task - A task that represents the asynchronous flush operation.
Read(byte[], int, int)
Section titled “Read(byte[], int, int)”When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
public override int Read(byte[] buffer, int offset, int count)Parameters
Section titled “Parameters”buffer(byte[]): An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.offset(int): The zero-based byte offset in buffer at which to begin storing the data read from the current stream.count(int): The maximum number of bytes to be read from the current stream.
Returns
Section titled “Returns”int - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached.
ReadAsync(Memory<byte>, CancellationToken)
Section titled “ReadAsync(Memory<byte>, CancellationToken)”Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”buffer(Memory<byte>): The region of memory to write the data into.cancellationToken(CancellationToken): The token to monitor for cancellation requests. The default value is None.
Returns
Section titled “Returns”ValueTask<int> - A task that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.
Seek(long, SeekOrigin)
Section titled “Seek(long, SeekOrigin)”When overridden in a derived class, sets the position within the current stream.
public override long Seek(long offset, SeekOrigin origin)Parameters
Section titled “Parameters”offset(long): A byte offset relative to the origin parameter.origin(SeekOrigin): A value of type SeekOrigin indicating the reference point used to obtain the new position.
Returns
Section titled “Returns”long - The new position within the current stream.
SetLength(long)
Section titled “SetLength(long)”When overridden in a derived class, sets the length of the current stream.
public override void SetLength(long value)Parameters
Section titled “Parameters”value(long): The desired length of the current stream in bytes.
Write(byte[], int, int)
Section titled “Write(byte[], int, int)”When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
public override void Write(byte[] buffer, int offset, int count)Parameters
Section titled “Parameters”buffer(byte[]): An array of bytes. This method copies count bytes from buffer to the current stream.offset(int): The zero-based byte offset in buffer at which to begin copying bytes to the current stream.count(int): The number of bytes to be written to the current stream.
WriteAsync(ReadOnlyMemory<byte>, CancellationToken)
Section titled “WriteAsync(ReadOnlyMemory<byte>, CancellationToken)”Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”buffer(ReadOnlyMemory<byte>): The region of memory to write data from.cancellationToken(CancellationToken): The token to monitor for cancellation requests. The default value is None.
Returns
Section titled “Returns”ValueTask - A task that represents the asynchronous write operation.
Properties
Section titled “Properties”CanRead
Section titled “CanRead”When overridden in a derived class, gets a value indicating whether the current stream supports reading.
public override bool CanRead { get; }Returns
Section titled “Returns”bool - true if the stream supports reading; otherwise, false.
CanSeek
Section titled “CanSeek”When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
public override bool CanSeek { get; }Returns
Section titled “Returns”bool - true if the stream supports seeking; otherwise, false.
CanWrite
Section titled “CanWrite”When overridden in a derived class, gets a value indicating whether the current stream supports writing.
public override bool CanWrite { get; }Returns
Section titled “Returns”bool - true if the stream supports writing; otherwise, false.
Length
Section titled “Length”When overridden in a derived class, gets the length in bytes of the stream.
public override long Length { get; }Returns
Section titled “Returns”long - A long value representing the length of the stream in bytes.
Position
Section titled “Position”When overridden in a derived class, gets or sets the position within the current stream.
public override long Position { get; set; }Returns
Section titled “Returns”long - The current position within the stream.