BufferedStream Class
Adds a buffering layer to read and write operations on another stream. This class cannot be inherited.
Assembly: mscorlib (in mscorlib.dll)
| Name | Description | |
|---|---|---|
 | BufferedStream(Stream) | Initializes a new instance of the BufferedStream class with a default buffer size of 4096 bytes. |
| BufferedStream(Stream, Int32) | Initializes a new instance of the BufferedStream class with the specified buffer size. |
| Name | Description | |
|---|---|---|
 | CanRead | Gets a value indicating whether the current stream supports reading.(Overrides Stream.CanRead.) |
| CanSeek | Gets a value indicating whether the current stream supports seeking.(Overrides Stream.CanSeek.) |
| CanTimeout | Gets a value that determines whether the current stream can time out.(Inherited from Stream.) |
| CanWrite | Gets a value indicating whether the current stream supports writing.(Overrides Stream.CanWrite.) |
| Length | Gets the stream length in bytes.(Overrides Stream.Length.) |
| Position | Gets the position within the current stream.(Overrides Stream.Position.) |
| ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
| WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
| Name | Description | |
|---|---|---|
| BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) | Begins an asynchronous read operation. (Consider using ReadAsync instead; see the Remarks section.)(Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).) |
| BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object) | Begins an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.)(Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).) |
| 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(Type) | 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() | |
| EndRead(IAsyncResult) | Waits for the pending asynchronous read operation to complete. (Consider using ReadAsync instead; see the Remarks section.)(Overrides Stream.EndRead(IAsyncResult).) |
| EndWrite(IAsyncResult) | Ends an asynchronous write operation and blocks until the I/O operation is complete. (Consider using WriteAsync instead; see the Remarks section.)(Overrides Stream.EndWrite(IAsyncResult).) |
| Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
| Flush() | Clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Overrides Stream.Flush().) |
| 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.(Overrides Stream.FlushAsync(CancellationToken).) |
| 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() | |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.) |
| Read(Byte[], Int32, Int32) | Copies bytes from the current buffered stream to an array.(Overrides Stream.Read(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.(Overrides Stream.ReadAsync(Byte[], Int32, Int32, CancellationToken).) |
| ReadByte() | Reads a byte from the underlying stream and returns the byte cast to an int, or returns -1 if reading from the end of the stream.(Overrides Stream.ReadByte().) |
| Seek(Int64, SeekOrigin) | Sets the position within the current buffered stream.(Overrides Stream.Seek(Int64, SeekOrigin).) |
| SetLength(Int64) | Sets the length of the buffered stream.(Overrides Stream.SetLength(Int64).) |
| ToString() | Returns a string that represents the current object.(Inherited from Object.) |
| Write(Byte[], Int32, Int32) | Copies bytes to the buffered stream and advances the current position within the buffered stream by the number of bytes written.(Overrides Stream.Write(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.(Overrides Stream.WriteAsync(Byte[], Int32, Int32, CancellationToken).) |
| WriteByte(Byte) | Writes a byte to the current position in the buffered stream.(Overrides Stream.WriteByte(Byte).) |
A buffer is a block of bytes in memory used to cache data, thereby reducing the number of calls to the operating system. Buffers improve read and write performance. A buffer can be used for either reading or writing, but never both simultaneously. The Read and Write methods of BufferedStream automatically maintain the buffer.
 Important |
|---|
This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic. |
BufferedStream can be composed around certain types of streams. It provides implementations for reading and writing bytes to an underlying data source or repository. Use BinaryReader and BinaryWriter for reading and writing other data types. BufferedStream is designed to prevent the buffer from slowing down input and output when the buffer is not needed. If you always read and write for sizes greater than the internal buffer size, then BufferedStream might not even allocate the internal buffer. BufferedStream also buffers reads and writes in a shared buffer. It is assumed that you will almost always be doing a series of reads or writes, but rarely alternate between the two of them.
The following code examples show how to use the BufferedStream class over the NetworkStream class to increase the performance of certain I/O operations. Start the server on a remote computer before starting the client. Specify the remote computer name as a command-line argument when starting the client. Vary the dataArraySize and streamBufferSize constants to view their effect on performance.
The first example shows the code that runs on the client, and the second example shows the code that runs on the server.
Example 1: Code that runs on the client
Available since 1.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.