host.anzo.eossdk.eos.sdk

Class EOS_Logging_Interface

java.lang.Object

host.anzo.eossdk.eos.sdk.EOS_Logging_Interface

public class EOS_Logging_Interface
extends java.lang.Object

The Logging Interface grants access to log output coming from the SDK at various levels of detail. Unlike other interfaces, the Logging Interface does not require a handle from the Platform Interface, as it functions entirely on the local system.

Since:

8/8/2023

Constructor Summary

Constructors

Constructor and Description
EOS_Logging_Interface()

Method Summary

Modifier and Type	Method and Description
static EOS_EResult	setCallback(EOS_LogMessageFunc callback) Set the callback function to use for SDK log messages.
static EOS_EResult	setLogLevel(EOS_ELogCategory logCategory, EOS_ELogLevel logLevel) Set the logging level for the specified logging category.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EOS_Logging_Interface

public EOS_Logging_Interface()

Method Detail

setLogLevel

public static EOS_EResult setLogLevel(EOS_ELogCategory logCategory,
                                      EOS_ELogLevel logLevel)

Set the logging level for the specified logging category. By default all log categories will callback for Warnings, Errors, and Fatals.

Parameters:

logCategory - the specific log category to configure. Use EOS_LC_ALL_CATEGORIES to configure all categories simultaneously to the same log level.

logLevel - the log level to use for the log category

Returns:

EOS_EResult.EOS_Success is returned if the log levels are now in use.
EOS_EResult.EOS_NotConfigured is returned if the SDK has not yet been initialized, or if it has been shut down.

setCallback

public static EOS_EResult setCallback(EOS_LogMessageFunc callback)

Set the callback function to use for SDK log messages. Any previously set callback will no longer be called.

Parameters:

callback - the function to call when the SDK logs messages

Returns:

EOS_EResult.EOS_Success is returned if the callback will be used for future log messages.
EOS_EResult.EOS_NotConfigured is returned if the SDK has not yet been initialized, or if it has been shut down

See Also:

EOSLibrary.EOS_Initialize(EOS_InitializeOptions)