Interface ISinkSystemInterface
Interface for a Sink
Inherited Members
Namespace: Unity.Logging.Sinks
Syntax
public interface ISinkSystemInterface : IDisposable
Methods
GetMinimalLogLevel()
Returns minimal LogLevel that this sink is interested in
Declaration
LogLevel GetMinimalLogLevel()
Returns
Type | Description |
---|---|
LogLevel | Minimal LogLevel that this sink is interested in |
Initialize(in Logger, in SinkConfiguration)
Method to initialize the sink
Declaration
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 |
NeedsStackTrace()
Returns true if stack traces are required
Declaration
bool NeedsStackTrace()
Returns
Type | Description |
---|---|
Boolean | True if stack traces are required |
ScheduleUpdate(LogControllerScopedLock, JobHandle)
Schedule update for this sink. Usually schedules internal Unity.Logging.Sinks.SinkJob`1
Declaration
JobHandle ScheduleUpdate(LogControllerScopedLock logControllerScopedLock, JobHandle dependency)
Parameters
Type | Name | Description |
---|---|---|
LogControllerScopedLock | logControllerScopedLock | |
JobHandle | dependency | Input dependency that should be done before this job |
Returns
Type | Description |
---|---|
JobHandle | Job handle for the SinkJob |
SetMinimalLogLevel(LogLevel)
Set minimal log level that this Sink is interested in
Declaration
void SetMinimalLogLevel(LogLevel minimalLevel)
Parameters
Type | Name | Description |
---|---|---|
LogLevel | minimalLevel | LogLevel to set as a minimal level |