Skip to content

Logging

Functions

Name
int wolfSSL_SetLoggingCb(wolfSSL_Logging_cb log_function)
This function registers a logging callback that will be used to handle the wolfSSL log message. By default, if the system supports it fprintf() to stderr is used but by using this function anything can be done by the user.

Functions Documentation

function wolfSSL_SetLoggingCb

int wolfSSL_SetLoggingCb(
    wolfSSL_Logging_cb log_function
)

This function registers a logging callback that will be used to handle the wolfSSL log message. By default, if the system supports it fprintf() to stderr is used but by using this function anything can be done by the user.

Parameters:

  • log_function function to register as a logging callback. Function signature must follow the above prototype.

See:

Return:

  • Success If successful this function will return 0.
  • BAD_FUNC_ARG is the error that will be returned if a function pointer is not provided.

Example

int ret = 0;
// Logging callback prototype
void MyLoggingCallback(const int logLevel, const char* const logMessage);
// Register the custom logging callback with wolfSSL
ret = wolfSSL_SetLoggingCb(MyLoggingCallback);
if (ret != 0) {
    // failed to set logging callback
}
void MyLoggingCallback(const int logLevel, const char* const logMessage)
{
// custom logging function
}

Updated on 2022-06-25 at 08:30:56 +0000