Class SinkSystemBase<TLoggerImpl>
Base Sink class that implements ISinkSystemInterface
Inheritance
SinkSystemBase<TLoggerImpl>
Syntax
public class SinkSystemBase<TLoggerImpl> : object, ISinkSystemInterface, IDisposable where TLoggerImpl : struct, ILogger
Type Parameters
| Name |
Description |
| TLoggerImpl |
Implementation of ILogger
|
Fields
CaptureStackTraces
Declaration
protected bool CaptureStackTraces
Field Value
IsInitialized
Declaration
protected bool IsInitialized
Field Value
Logger
Declaration
Field Value
LoggerImpl
Declaration
protected TLoggerImpl LoggerImpl
Field Value
| Type |
Description |
| TLoggerImpl |
|
MinimalLevel
Declaration
protected LogLevel MinimalLevel
Field Value
OutputTemplate
Declaration
protected FixedString512Bytes OutputTemplate
Field Value
| Type |
Description |
| FixedString512Bytes |
|
SystemConfig
Declaration
protected SinkConfiguration SystemConfig
Field Value
Methods
Dispose()
Declaration
public virtual void 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
Initialize(in Logger, in SinkConfiguration)
Method to initialize the sink
Declaration
public virtual void Initialize(in Logger logger, in SinkConfiguration systemConfig)
Parameters
Implements
NeedsStackTrace()
Declaration
public bool NeedsStackTrace()
Returns
Implements
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
SetMinimalLogLevel(LogLevel)
Set minimal log level that this Sink is interested in
Declaration
public void SetMinimalLogLevel(LogLevel minimalLevel)
Parameters
Implements
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.