expvintl
103 lines
3.6 KiB
C
103 lines
3.6 KiB
C
// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
|
|
#pragma once
|
|
|
|
#include "eos_base.h"
|
|
|
|
#pragma pack(push, 8)
|
|
|
|
/**
|
|
* Logging levels. When a log message is output, it has an associated log level.
|
|
* Messages will only be sent to the callback function if the message's associated log level is less than or equal to the configured log level for that category.
|
|
*
|
|
* @see EOS_Logging_SetCallback
|
|
* @see EOS_Logging_SetLogLevel
|
|
*/
|
|
EOS_ENUM(EOS_ELogLevel,
|
|
EOS_LOG_Off = 0,
|
|
EOS_LOG_Fatal = 100,
|
|
EOS_LOG_Error = 200,
|
|
EOS_LOG_Warning = 300,
|
|
EOS_LOG_Info = 400,
|
|
EOS_LOG_Verbose = 500,
|
|
EOS_LOG_VeryVerbose = 600
|
|
);
|
|
|
|
/**
|
|
* Logging Categories
|
|
*/
|
|
EOS_ENUM(EOS_ELogCategory,
|
|
/** Low level logs unrelated to specific services */
|
|
EOS_LC_Core = 0,
|
|
/** Logs related to the Auth service */
|
|
EOS_LC_Auth = 1,
|
|
/** Logs related to the Friends service */
|
|
EOS_LC_Friends = 2,
|
|
/** Logs related to the Presence service */
|
|
EOS_LC_Presence = 3,
|
|
/** Logs related to the UserInfo service */
|
|
EOS_LC_UserInfo = 4,
|
|
/** Logs related to HTTP serialization */
|
|
EOS_LC_HttpSerialization = 5,
|
|
/** Logs related to the Ecommerce service */
|
|
EOS_LC_Ecom = 6,
|
|
/** Logs related to the P2P service */
|
|
EOS_LC_P2P = 7,
|
|
/** Logs related to the Sessions service */
|
|
EOS_LC_Sessions = 8,
|
|
/** Logs related to rate limiting */
|
|
EOS_LC_RateLimiter = 9,
|
|
/** Logs related to sdk analytics */
|
|
EOS_LC_Analytics = 11,
|
|
/** Logs related to the messaging API */
|
|
EOS_LC_Messaging = 12,
|
|
/** Logs related to the Connect API */
|
|
EOS_LC_Connect = 13,
|
|
/** Logs related to the Overlay */
|
|
EOS_LC_Overlay = 14,
|
|
|
|
/** Not a real log category. Used by EOS_Logging_SetLogLevel to set the log level for all categories at the same time */
|
|
EOS_LC_ALL_CATEGORIES = 0x7fffffff
|
|
);
|
|
|
|
/** A structure representing a log message */
|
|
EOS_STRUCT(EOS_LogMessage, (
|
|
/** A string representation of the log message category, encoded in UTF-8. Only valid during the life of the callback, so copy the string if you need it later. */
|
|
const char* Category;
|
|
/** The log message, encoded in UTF-8. Only valid during the life of the callback, so copy the string if you need it later. */
|
|
const char* Message;
|
|
/** The log level associated with the message */
|
|
EOS_ELogLevel Level;
|
|
));
|
|
|
|
/**
|
|
* Function prototype definition for functions that receive log messages.
|
|
*
|
|
* @param Message A EOS_LogMessage containing the log category, log level, and message.
|
|
* @see EOS_LogMessage
|
|
*/
|
|
EXTERN_C typedef void (EOS_CALL * EOS_LogMessageFunc)(const EOS_LogMessage* Message);
|
|
|
|
/**
|
|
* Set the callback function to use for SDK log messages. Any previously set callback will no longer be called.
|
|
*
|
|
* @param Callback the function to call when the SDK logs messages
|
|
* @return EOS_Success is returned if the callback will be used for future log messages.
|
|
* EOS_NotConfigured is returned if the SDK has not yet been initialized, or if it has been shut down
|
|
*
|
|
* @see EOS_Init
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Logging_SetCallback(EOS_LogMessageFunc Callback);
|
|
|
|
/**
|
|
* Set the logging level for the specified logging category. By default all log categories will callback for Warnings, Errors, and Fatals.
|
|
*
|
|
* @param LogCategory the specific log category to configure. Use EOS_LC_ALL_CATEGORIES to configure all categories simultaneously to the same log level.
|
|
* @param LogLevel the log level to use for the log category
|
|
*
|
|
* @return EOS_Success is returned if the log levels are now in use.
|
|
* EOS_NotConfigured is returned if the SDK has not yet been initialized, or if it has been shut down.
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Logging_SetLogLevel(EOS_ELogCategory LogCategory, EOS_ELogLevel LogLevel);
|
|
|
|
#pragma pack(pop)
|