Typedefs | Functions
td_log.h File Reference

Description

C interface for managing the internal logging of TDLib. By default TDLib writes logs to stderr or an OS specific log and uses a verbosity level of 5.

Go to the source code of this file.

Typedefs

typedef void(* td_log_fatal_error_callback_ptr) (const char *error_message)
 

Functions

int td_set_log_file_path (const char *file_path)
 
void td_set_log_max_file_size (long long max_file_size)
 
void td_set_log_verbosity_level (int new_verbosity_level)
 
void td_set_log_fatal_error_callback (td_log_fatal_error_callback_ptr callback)
 

Typedef Documentation

◆ td_log_fatal_error_callback_ptr

typedef void(* td_log_fatal_error_callback_ptr) (const char *error_message)

A type of callback function that will be called when a fatal error happens.

Parameters
error_messageNull-terminated string with a description of a happened fatal error.

Function Documentation

◆ td_set_log_file_path()

int td_set_log_file_path ( const char *  file_path)

Sets the path to the file where the internal TDLib log will be written. By default TDLib writes logs to stderr or an OS specific log. Use this method to write the log to a file instead.

Parameters
[in]file_pathNull-terminated path to a file where the internal TDLib log will be written. Use an empty path to switch back to the default logging behaviour.
Returns
True 1 on success, or 0 otherwise, i.e. if the file can't be opened for writing.

◆ td_set_log_max_file_size()

void td_set_log_max_file_size ( long long  max_file_size)

Sets maximum size of the file to where the internal TDLib log is written before the file will be auto-rotated. Unused if log is not written to a file. Defaults to 10 MB.

Parameters
[in]max_file_sizeMaximum size of the file to where the internal TDLib log is written before the file will be auto-rotated. Should be positive.

◆ td_set_log_verbosity_level()

void td_set_log_verbosity_level ( int  new_verbosity_level)

Sets the verbosity level of the internal logging of TDLib. By default the TDLib uses a log verbosity level of 5.

Parameters
[in]new_verbosity_levelNew value of logging verbosity level. Value 0 corresponds to fatal errors, value 1 corresponds to errors, value 2 corresponds to warnings and debug warnings, value 3 corresponds to informational, value 4 corresponds to debug, value 5 corresponds to verbose debug, value greater than 5 and up to 1024 can be used to enable even more logging.

◆ td_set_log_fatal_error_callback()

void td_set_log_fatal_error_callback ( td_log_fatal_error_callback_ptr  callback)

Sets the callback that will be called when a fatal error happens. None of the TDLib methods can be called from the callback. The TDLib will crash as soon as callback returns. By default the callback is not set.

Parameters
[in]callbackCallback that will be called when a fatal error happens. Pass NULL to remove the callback.