Class LogStream

Namespace: Sisk.Core.Http
Assembly: Sisk.Core.dll

Provides a managed, asynchronous log writer which supports writing safe data to log files or text streams.

public class LogStream : IDisposable, IAsyncDisposable

Inheritance

object ← LogStream

Derived

PrefixedLogStream

Implements

IDisposable, IAsyncDisposable

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

LogStream()

Creates an new LogStream instance with no predefined outputs.

LogStream(TextWriter)

Creates an new LogStream instance with the given TextWriter object.

LogStream(string)

Creates an new LogStream instance with the given relative or absolute file path.

LogStream(string?, TextWriter?)

Creates an new LogStream instance which writes text to an file and an TextWriter.

Properties

ConsoleOutput

Gets a shared LogStream that writes its output to the Out stream.

Disposed

Gets an boolean indicating if this LogStream was disposed.

Empty

Gets a shared LogStream without any output stream.

Encoding

Gets or sets the encoding used for writting data to the output file. This property is only appliable if this instance is using an file-based output.

FilePath

Gets or sets the absolute path to the file where the log is being written to.

IsBuffering

Gets an boolean indicating if this LogStream is buffering output messages to their internal message buffer.

NormalizeEntries

Gets or sets a boolean that indicates that every input must be trimmed and have their line endings normalized before being written to the output stream.

RotatingPolicy

Gets the defined RotatingLogPolicy for this LogStream.

TextWriter

Gets the TextWriter object where the log is being written to.

Methods

Close()

Writes all pending logs from the queue and closes all resources used by this object.

ConfigureRotatingPolicy(long, TimeSpan)

Defines the time interval and size threshold for starting the task, and then starts the task. This method is an shortcut for calling Sisk.Core.Http.RotatingLogPolicy.Configure(System.Int64,System.TimeSpan) of this defined RotatingPolicy method.

Dispose()

Writes all pending logs from the queue and closes all resources used by this object.

DisposeAsync()

Asynchronously writes all pending logs from the queue and closes all resources used by this object.

~LogStream()

Flush()

Blocks the current thread until all currently enqueued content is written to the underlying streams.

FlushAsync()

Asynchronously waits until all currently enqueued content is written to the underlying streams.

Peek()

Reads the output buffer. To use this method, it's required to set this LogStream buffering with StartBuffering(int).

StartBuffering(int)

Start buffering all output to an alternate stream in memory for readability with Peek() later.

StopBuffering()

Stops buffering output.

WriteException(Exception)

Writes an exception description in the log.

WriteException(Exception, string?)

Writes an exception description in the log.

WriteExceptionAsync(Exception)

Writes an exception description in the log.

WriteExceptionAsync(Exception, string?)

Writes an exception description in the log.

WriteLine()

Writes an line-break at the end of the output.

WriteLine(object?)

Writes the text and concats an line-break at the end into the output.

WriteLine(string)

Writes the text and concats an line-break at the end into the output.

WriteLine(string, params ReadOnlySpan<object?>)

Writes the text format and arguments and concats an line-break at the end into the output.

WriteLine(string, params IEnumerable<object?>)

Writes the text format and arguments and concats an line-break at the end into the output.

WriteLine(IFormatProvider?, string, params object?[])

Writes the text format and arguments and appends a line-break at the end into the output, using the specified format provider.

WriteLineAsync()

Writes an line-break at the end of the output.

WriteLineAsync(object?)

Writes the text and concats an line-break at the end into the output.

WriteLineAsync(string)

Writes the text and concats an line-break at the end into the output.

WriteLineAsync(string, params IEnumerable<object?>)

Writes the text format and arguments and concats an line-break at the end into the output.

WriteLineAsync(IFormatProvider?, string, params object?[])

Writes the text format and arguments and appends a line-break at the end into the output, using the specified format provider.

WriteLineInternal(string)

Represents the method that intercepts the line that will be written to an output log before being queued for writing. This method will block if the log queue is full.

WriteLineInternalAsync(string)

Represents the asynchronous method that intercepts the line that will be written to an output log before being queued for writing.