BBStream Class |
Stream wrapper which adds ability to flush and check for
available data on all streams which need to be accessed.
Also adds ability to have a timeout on stream read and writes without the
underlying connection closing on failure
Inheritance HierarchyNamespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe BBStream type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BaseStream | the underlying stream |
| CanRead |
Indicates whether the current stream supports reading
(Overrides StreamCanRead) |
| CanSeek |
Indicates whether the current stream supports seeking
(Overrides StreamCanSeek) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream) |
| CanWrite |
Indicates whether the current stream supports writing
(Overrides StreamCanWrite) |
| DataAvailable | Indicates whether data is available, can be 0, for no data, 1 for 1 or more bytes, or a number representing the precise number of bytes |
| Length |
Gets the length in bytes of the stream
(Overrides StreamLength) |
| Position |
Gets or sets the position within the current stream
(Overrides StreamPosition) |
| ReadTimeout |
Read timeout for BBStream
(Overrides StreamReadTimeout) |
| WriteTimeout |
Write timeout for BBStream
(Overrides StreamWriteTimeout) |
Methods| Name | Description | |
|---|---|---|
 | BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream) |
| Close | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream) |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream) |
| CopyToAsync(Stream, Int32) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream) |
| CopyToAsync(Stream, Int32, CancellationToken) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Inherited from Stream) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Flush |
Clear the read and write streams
(Overrides StreamFlush) |
| FlushAsync | Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream) |
| FlushAsync(CancellationToken) | Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. (Inherited from Stream) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| Read |
Read from stream
(Overrides StreamRead(Byte, Int32, Int32)) |
| ReadAsync(Byte, Int32, Int32) | Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream) |
| ReadAsync(Byte, Int32, Int32, 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. (Inherited from Stream) |
| ReadByte | Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from Stream) |
| Seek |
Sets the position within the stream
(Overrides StreamSeek(Int64, SeekOrigin)) |
| SetLength |
Sets the length of the current stream
(Overrides StreamSetLength(Int64)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Write |
Write to stream
(Overrides StreamWrite(Byte, Int32, Int32)) |
| WriteAsync(Byte, Int32, Int32) | Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream) |
| WriteAsync(Byte, Int32, Int32, 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. (Inherited from Stream) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream) |
See Also