GRPC C++  1.30.0
Data Structures | Macros | Typedefs | Enumerations | Functions
log.h File Reference
#include <grpc/impl/codegen/port_platform.h>
#include <stdarg.h>
#include <stdlib.h>

Go to the source code of this file.

Data Structures

struct  gpr_log_func_args
 Log overrides: applications can use this API to intercept logging calls and use their own implementations. More...
 

Macros

#define GPR_LOG_VERBOSITY_UNSET   -1
 
#define GPR_DEBUG   __FILE__, __LINE__, GPR_LOG_SEVERITY_DEBUG
 Macros to build log contexts at various severity levels. More...
 
#define GPR_INFO   __FILE__, __LINE__, GPR_LOG_SEVERITY_INFO
 
#define GPR_ERROR   __FILE__, __LINE__, GPR_LOG_SEVERITY_ERROR
 
#define GPR_ASSERT(x)
 abort() the process if x is zero, having written a line to the log. More...
 
#define GPR_DEBUG_ASSERT(x)   GPR_ASSERT(x)
 

Typedefs

typedef enum gpr_log_severity gpr_log_severity
 GPR log API. More...
 
typedef struct gpr_log_func_args gpr_log_func_args
 
typedef void(* gpr_log_func) (gpr_log_func_args *args)
 

Enumerations

enum  gpr_log_severity { GPR_LOG_SEVERITY_DEBUG, GPR_LOG_SEVERITY_INFO, GPR_LOG_SEVERITY_ERROR }
 GPR log API. More...
 

Functions

const GPRAPI char * gpr_log_severity_string (gpr_log_severity severity)
 Returns a string representation of the log severity. More...
 
GPRAPI void gpr_log (const char *file, int line, gpr_log_severity severity, const char *format,...) GPR_PRINT_FORMAT_CHECK(4
 Log a message. More...
 
GPRAPI void GPRAPI int gpr_should_log (gpr_log_severity severity)
 
GPRAPI void gpr_log_message (const char *file, int line, gpr_log_severity severity, const char *message)
 
GPRAPI void gpr_set_log_verbosity (gpr_log_severity min_severity_to_print)
 Set global log verbosity. More...
 
GPRAPI void gpr_log_verbosity_init (void)
 
GPRAPI void gpr_set_log_function (gpr_log_func func)
 

Macro Definition Documentation

◆ GPR_ASSERT

#define GPR_ASSERT (   x)
Value:
do { \
if (GPR_UNLIKELY(!(x))) { \
gpr_log(GPR_ERROR, "assertion failed: %s", #x); \
abort(); \
} \
} while (0)

abort() the process if x is zero, having written a line to the log.

Intended for internal invariants. If the error can be recovered from, without the possibility of corruption, or might best be reflected via an exception in a higher-level language, consider returning error code.

◆ GPR_DEBUG

#define GPR_DEBUG   __FILE__, __LINE__, GPR_LOG_SEVERITY_DEBUG

Macros to build log contexts at various severity levels.

◆ GPR_DEBUG_ASSERT

#define GPR_DEBUG_ASSERT (   x)    GPR_ASSERT(x)

◆ GPR_ERROR

#define GPR_ERROR   __FILE__, __LINE__, GPR_LOG_SEVERITY_ERROR

◆ GPR_INFO

#define GPR_INFO   __FILE__, __LINE__, GPR_LOG_SEVERITY_INFO

◆ GPR_LOG_VERBOSITY_UNSET

#define GPR_LOG_VERBOSITY_UNSET   -1

Typedef Documentation

◆ gpr_log_func

typedef void(* gpr_log_func) (gpr_log_func_args *args)

◆ gpr_log_func_args

◆ gpr_log_severity

GPR log API.

Usage (within grpc):

int argument1 = 3; char* argument2 = "hello"; gpr_log(GPR_DEBUG, "format string %d", argument1); gpr_log(GPR_INFO, "hello world"); gpr_log(GPR_ERROR, "%d %s!!", argument1, argument2); The severity of a log message - use the #defines below when calling into gpr_log to additionally supply file and line data

Enumeration Type Documentation

◆ gpr_log_severity

GPR log API.

Usage (within grpc):

int argument1 = 3; char* argument2 = "hello"; gpr_log(GPR_DEBUG, "format string %d", argument1); gpr_log(GPR_INFO, "hello world"); gpr_log(GPR_ERROR, "%d %s!!", argument1, argument2); The severity of a log message - use the #defines below when calling into gpr_log to additionally supply file and line data

Enumerator
GPR_LOG_SEVERITY_DEBUG 
GPR_LOG_SEVERITY_INFO 
GPR_LOG_SEVERITY_ERROR 

Function Documentation

◆ gpr_log()

GPRAPI void gpr_log ( const char *  file,
int  line,
gpr_log_severity  severity,
const char *  format,
  ... 
)

Log a message.

It's advised to use GPR_xxx above to generate the context for each message

◆ gpr_log_message()

GPRAPI void gpr_log_message ( const char *  file,
int  line,
gpr_log_severity  severity,
const char *  message 
)

◆ gpr_log_severity_string()

const GPRAPI char* gpr_log_severity_string ( gpr_log_severity  severity)

Returns a string representation of the log severity.

◆ gpr_log_verbosity_init()

GPRAPI void gpr_log_verbosity_init ( void  )

◆ gpr_set_log_function()

GPRAPI void gpr_set_log_function ( gpr_log_func  func)

◆ gpr_set_log_verbosity()

GPRAPI void gpr_set_log_verbosity ( gpr_log_severity  min_severity_to_print)

Set global log verbosity.

◆ gpr_should_log()

GPRAPI void GPRAPI int gpr_should_log ( gpr_log_severity  severity)
GPR_UNLIKELY
#define GPR_UNLIKELY(x)
Definition: port_platform.h:713
GPR_ERROR
#define GPR_ERROR
Definition: log.h:57