Agora C++ API Reference for All Platforms
Namespaces | Classes | Enumerations | Functions | Variables
agora::commons Namespace Reference

Namespaces

 cjson
 
 network
 

Classes

class  ILogWriter
 
struct  LogConfig
 

Enumerations

enum  log_filters {
  LOG_NONE = 0x0000, LOG_INFO = 0x0001, LOG_WARN = 0x0002, LOG_ERROR = 0x0004,
  LOG_FATAL = 0x0008, LOG_DEFAULT = 0x000f, LOG_API_CALL = 0x0010, LOG_MODULE_CALL = 0x0020,
  LOG_QUALITY = 0x0040, LOG_DIAGNOSE = 0x0080, LOG_MEM = 0x0100, LOG_TIMER = 0x0200,
  LOG_STREAM = 0x0400, LOG_DEBUG = 0x0800, LOG_USER_API_CALL = 0x1000, LOG_CONSOLE = 0x8000,
  LOG_ALL = 0xffff, LOG_NO_API = 0xffef, LOG_INVALID = (int32_t)-1
}
 
enum  LOG_FILTER_TYPE {
  LOG_FILTER_OFF = 0, LOG_FILTER_DEBUG = 0x080f, LOG_FILTER_INFO = 0x000f, LOG_FILTER_WARN = 0x000e,
  LOG_FILTER_ERROR = 0x000c, LOG_FILTER_CRITICAL = 0x0008, LOG_FILTER_MASK = 0x80f
}
 

Functions

 __attribute__ ((format(printf, 2, 3))) void log(log_filters level
 

Variables

const char * fmt
 
OPTIONAL_ENUM_CLASS LOG_LEVEL
 
const uint32_t MAX_LOG_SIZE = 20 * 1024 * 1024
 
const uint32_t MIN_LOG_SIZE = 128 * 1024
 
const uint32_t DEFAULT_LOG_SIZE_IN_KB = 1024
 

Enumeration Type Documentation

◆ log_filters

Enumerator
LOG_NONE 
LOG_INFO 
LOG_WARN 
LOG_ERROR 
LOG_FATAL 
LOG_DEFAULT 
LOG_API_CALL 
LOG_MODULE_CALL 
LOG_QUALITY 
LOG_DIAGNOSE 
LOG_MEM 
LOG_TIMER 
LOG_STREAM 
LOG_DEBUG 
LOG_USER_API_CALL 
LOG_CONSOLE 
LOG_ALL 
LOG_NO_API 
LOG_INVALID 

◆ LOG_FILTER_TYPE

Enumerator
LOG_FILTER_OFF 
LOG_FILTER_DEBUG 
LOG_FILTER_INFO 
LOG_FILTER_WARN 
LOG_FILTER_ERROR 
LOG_FILTER_CRITICAL 
LOG_FILTER_MASK 

Function Documentation

◆ __attribute__()

agora::commons::__attribute__ ( (format(printf, 2, 3))  )

Variable Documentation

◆ fmt

const char* agora::commons::fmt

◆ LOG_LEVEL

OPTIONAL_ENUM_CLASS agora::commons::LOG_LEVEL
Initial value:
{
LOG_LEVEL_NONE = 0x0000,
LOG_LEVEL_INFO = 0x0001,
LOG_LEVEL_WARN = 0x0002,
LOG_LEVEL_ERROR = 0x0004,
LOG_LEVEL_FATAL = 0x0008,
LOG_LEVEL_API_CALL = 0x0010,
}

Supported logging severities of SDK

◆ MAX_LOG_SIZE

const uint32_t agora::commons::MAX_LOG_SIZE = 20 * 1024 * 1024

◆ MIN_LOG_SIZE

const uint32_t agora::commons::MIN_LOG_SIZE = 128 * 1024

◆ DEFAULT_LOG_SIZE_IN_KB

const uint32_t agora::commons::DEFAULT_LOG_SIZE_IN_KB = 1024

The default log size in kb