C# Class GSF.IO.BinaryStreamStream

A Stream wrapper around a BinaryStreamBase.

A Stream inherits from MarshalByRefObject which prevents any methods from inlining. Therefore a BinaryStreamBase will not inhert from Stream.

Inheritance: Stream

Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Properties

Property	Type	Description
BaseStream	BinaryStreamBase

Public Methods

Method	Description
Flush ( ) : void	When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
Read ( byte buffer, int offset, int count ) : 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.
Seek ( long offset, SeekOrigin origin ) : long	When overridden in a derived class, sets the position within the current stream.
SetLength ( long value ) : void	When overridden in a derived class, sets the length of the current stream.
Write ( byte buffer, int offset, int count ) : void	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.

Private Methods

Method	Description
BinaryStreamStream ( BinaryStreamBase baseStream ) : System	Creates a Stream wrapper around a BinaryStreamBase.

Method Details

Flush() public method

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

An I/O error occurs.

public Flush ( ) : void
return	void

Read() public method

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.

The sum of and is larger than the buffer length. is null. or is negative. An I/O error occurs. The stream does not support reading. Methods were called after the stream was closed.

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.
offset	int	The zero-based byte offset in 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.
return	int

Seek() public method

When overridden in a derived class, sets the position within the current stream.

An I/O error occurs. The stream does not support seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed.

public Seek ( long offset, SeekOrigin origin ) : long
offset	long	A byte offset relative to the parameter.
origin	SeekOrigin	A value of type indicating the reference point used to obtain the new position.
return	long

SetLength() public method

When overridden in a derived class, sets the length of the current stream.

An I/O error occurs. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed.

public SetLength ( long value ) : void
value	long	The desired length of the current stream in bytes.
return	void

Write() public method

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 Write ( byte buffer, int offset, int count ) : void
buffer	byte	An array of bytes. This method copies bytes from to the current stream.
offset	int	The zero-based byte offset in at which to begin copying bytes to the current stream.
count	int	The number of bytes to be written to the current stream.
return	void

Property Details

BaseStream public property

public BinaryStreamBase,GSF.IO BaseStream
return	BinaryStreamBase