Class SinkSystemBase<TLoggerImpl>

Base Sink class that implements ISinkSystemInterface

Inheritance

Object

SinkSystemBase<TLoggerImpl>

ConsoleSinkSystem

FileSinkSystemBase<T>

JsonFileSinkSystemBase<T>

StringSink

UnityDebugLogSink

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Logging.Sinks

Syntax

[BurstCompile]
public class SinkSystemBase<TLoggerImpl> : ISinkSystemInterface, IDisposable where TLoggerImpl : struct, ILogger

Type Parameters

Name	Description
TLoggerImpl	Implementation of ILogger

Fields

CaptureStackTraces

Declaration

protected bool CaptureStackTraces

Field Value

Type	Description
Boolean

IsInitialized

Declaration

protected bool IsInitialized

Field Value

Type	Description
Boolean

Logger

Declaration

protected Logger Logger

Field Value

Type	Description
Logger

LoggerImpl

Declaration

protected TLoggerImpl LoggerImpl

Field Value

Type	Description
TLoggerImpl

MinimalLevel

Declaration

protected LogLevel MinimalLevel

Field Value

Type	Description
LogLevel

OutputTemplate

Declaration

protected FixedString512Bytes OutputTemplate

Field Value

Type	Description
FixedString512Bytes

SystemConfig

Declaration

protected SinkConfiguration SystemConfig

Field Value

Type	Description
SinkConfiguration

Methods

Dispose()

See IDisposable

Declaration

public virtual void Dispose()

Implements

IDisposable.Dispose()

GetMinimalLogLevel()

Get minimal log level that this Sink is interested in

Declaration

public LogLevel GetMinimalLogLevel()

Returns

Type	Description
LogLevel	Minimal log level that this Sink is interested in

Implements

ISinkSystemInterface.GetMinimalLogLevel()

Initialize(in Logger, in SinkConfiguration)

Method to initialize the sink

Declaration

public virtual void Initialize(in Logger logger, in SinkConfiguration systemConfig)

Parameters

Type	Name	Description
Logger	logger	Parent Logger
SinkConfiguration	systemConfig	SinkConfiguration-inherited class that contains specialized configurations for the sink

Implements

ISinkSystemInterface.Initialize(in Logger, in SinkConfiguration)

Exceptions

Type	Condition
Exception	If logger.Handle.IsValid is false

NeedsStackTrace()

Declaration

public bool NeedsStackTrace()

Returns

Type	Description
Boolean

Implements

ISinkSystemInterface.NeedsStackTrace()

OnSinkFatalError(FixedString512Bytes)

Declaration

protected void OnSinkFatalError(FixedString512Bytes reason)

Parameters

Type	Name	Description
FixedString512Bytes	reason

ScheduleUpdate(LogControllerScopedLock, JobHandle)

Schedule update for this sink. Usually schedules internal Unity.Logging.Sinks.SinkJob`1

Declaration

public virtual JobHandle ScheduleUpdate(LogControllerScopedLock lock, JobHandle dependency)

Parameters

Type	Name	Description
LogControllerScopedLock	lock
JobHandle	dependency	Input dependency that should be done before this job

Returns

Type	Description
JobHandle	Job handle for the SinkJob

Implements

ISinkSystemInterface.ScheduleUpdate(LogControllerScopedLock, JobHandle)

SetMinimalLogLevel(LogLevel)

Set minimal log level that this Sink is interested in

Declaration

public void SetMinimalLogLevel(LogLevel minimalLevel)

Parameters

Type	Name	Description
LogLevel	minimalLevel	LogLevel to set as a minimal level

Implements

ISinkSystemInterface.SetMinimalLogLevel(LogLevel)