89f7ce31 7d46 ee52 f858 c5bf5972ba99

LoggerStream Class

This feature class represents one additional implementation of the abstract class Stream.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      Plexdata.LogWriter.Features.LoggerStream
Namespace: Plexdata.LogWriter.Features
Assembly: Plexdata.LogWriter.Stream (in Plexdata.LogWriter.Stream.dll) Version: 1.0.7.1

Syntax

C#

public class LoggerStream : Stream

The LoggerStream type exposes the following members.

Constructors

 

	Name	Description
	LoggerStream	The static class constructor.
	LoggerStream()	The standard class constructor.
	LoggerStream(Encoding)	The extended class constructor.

  Back to Top

Properties

 

	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.)
	Encoding	Gets or sets the used file encoding.
	Length	Gets the length in bytes of the stream. (Overrides Stream.Length.)
	Position	Gets or sets 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.)

  Back to Top

Methods

 

	Name	Description
	__RaceSetServerIdentity	(Inherited from MarshalByRefObject.)
	__ResetServerIdentity	(Inherited from MarshalByRefObject.)
	BeginRead	Begins an asynchronous read operation. (Consider using ReadAsync(Byte[], Int32, Int32) instead.) (Inherited from Stream.)
	BeginReadInternal	(Inherited from Stream.)
	BeginWrite	Begins an asynchronous write operation. (Consider using WriteAsync(Byte[], Int32, Int32) instead.) (Inherited from Stream.)
	BeginWriteInternal	(Inherited from Stream.)
	BlockingBeginRead	(Inherited from Stream.)
	BlockingBeginWrite	(Inherited from Stream.)
	CanCastToXmlType	(Inherited from MarshalByRefObject.)
	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.)
	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 Stream and optionally releases the managed resources. (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.)
	EnsureAsyncActiveSemaphoreInitialized	(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	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. (Inherited from Stream.)
	GetComIUnknown	(Inherited from MarshalByRefObject.)
	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.)
	InvokeMember	(Inherited from MarshalByRefObject.)
	IsInstanceOfType	(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	Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (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. (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 Stream.Seek(Int64, SeekOrigin).)
	SetLength	Sets the length of the current stream. (Overrides Stream.SetLength(Int64).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Write	Writes a sequence of bytes to the current stream and advances the current position within this 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. (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.)

  Back to Top

Events

 

	Name	Description
	ProcessStreamData	Occurs when all available stream data should be processed by any attached event listener.

  Back to Top

Fields

 

	Name	Description
	DefaultEncoding	The default encoding value.
	encoding	This field holds the chosen encoding.
	ETB	The End of Transmission Block control character.
	messages	This field holds the available list of messages.

  Back to Top

Remarks

Main feature of this class is that it is event driven. This in turn means that writing into this stream and flushing it causes an event which informs every assigned listener about receiving new data.

This stream implementation might be used together with IStreamLogger or with IStreamLogger(TContext) and can be applied using IStreamLoggerSettings.

But pay attention, this stream implementation only supports stream writing. The other way round, reading or seeking this stream is intentionally impossible!

See Also

Reference

Plexdata.LogWriter.Features Namespace