WriteBufferedStream Class

Provides an extra layer of write buffering for a stream.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.IOStream
      Ookii.Jumbo.IOWriteBufferedStream

Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 2.0.0

Syntax

C++

Copy

public class WriteBufferedStream : Stream

Public Class WriteBufferedStream
	Inherits Stream

public ref class WriteBufferedStream : public Stream

type WriteBufferedStream =  
    class
        inherit Stream
    end

The WriteBufferedStream type exposes the following members.

Constructors

	Name	Description
	WriteBufferedStream(Stream)	Initializes a new instance of the WriteBufferedStream class with the default buffer size of 64KB.
	WriteBufferedStream(Stream, Int32)	Initializes a new instance of the WriteBufferedStream class with the specified buffer size.

Top

Properties

	Name	Description
	CanRead	Gets a value that indicates whether the current stream supports reading. (Overrides StreamCanRead.)
	CanSeek	Gets a value that 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	Gets a value that indicates whether the current stream supports writing. (Overrides StreamCanWrite.)
	Length	Gets the length of the stream. (Overrides StreamLength.)
	Position	Gets or sets the current stream position. (Overrides StreamPosition.)
	ReadTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
	WriteTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)

Top

Methods

	Name	Description
	BeginRead	Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	BeginWrite	Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (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, CancellationToken)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. (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.)
	CreateWaitHandle	Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
	Dispose	Releases all resources used by the Stream. (Inherited from Stream.)
	Dispose(Boolean)	Releases the unmanaged resources used by the WriteBufferedStream and optionally releases the managed resources. (Overrides StreamDispose(Boolean).)
	DisposeAsync	Asynchronously releases the unmanaged resources used by the Stream. (Inherited from Stream.)
	EndRead	Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	EndWrite	Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	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.)
	Flush	Flushes the contents of the write buffer to the underlying stream. (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	Obsolete. 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	Obsolete. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ObjectInvariant	Obsolete. Provides support for a Contract. (Inherited from Stream.)
	Read(SpanByte)	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. (Inherited from Stream.)
	Read(Byte, Int32, Int32)	Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Overrides StreamRead(Byte, Int32, Int32).)
	ReadAsync(MemoryByte, 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.)
	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 current 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(ReadOnlySpanByte)	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. (Inherited from Stream.)
	Write(Byte, Int32, Int32)	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Overrides StreamWrite(Byte, Int32, Int32).)
	WriteAsync(ReadOnlyMemoryByte, 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.)
	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.)

Top

Extension Methods

	Name	Description
	CopySize(Stream, Int64)	Overloaded. Copies the specified number of bytes from one stream to another using the default buffer size. (Defined by StreamExtensions.)
	CopySize(Stream, Int64, Int32)	Overloaded. Copies the specified number of bytes from one stream to another using the specified buffer size. (Defined by StreamExtensions.)
	CopyTo(Stream)	Overloaded. Copies one stream to another. (Defined by StreamExtensions.)
	CopyTo(Stream, Int32)	Overloaded. Copies one stream to another using the specified buffer size. (Defined by StreamExtensions.)
	CreateCompressor	Creates a compressor for the specified stream. (Defined by CompressionUtility.)
	CreateDecompressor	Creates a decompressor for the specified stream. (Defined by CompressionUtility.)

Top

Remarks

This class is intended for use by the data servers when they send blocks to more efficiently pack the data into packets than what NetworkStream provides.

Unfortunately, the BufferedStream class did not provide the required behaviour on Mono (it would bypass the buffer on a large write) so that's why this class is necessary.

Reference

Ookii.Jumbo.IO Namespace