logging.h 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /*!
  2. \ingroup Logging
  3. \brief この関数は、WolfSSLログメッセージを処理するために使用されるロギングコールバックを登録します。デフォルトでは、システムがIT fprintf()をSTDERRにサポートしている場合は、この関数を使用することによって、ユーザーによって何でも実行できます。
  4. \return Success 成功した場合、この関数は0を返します。
  5. \return BAD_FUNC_ARG 関数ポインタが提供されていない場合に返されるエラーです。
  6. _Example_
  7. \code
  8. int ret = 0;
  9. // Logging callback prototype
  10. void MyLoggingCallback(const int logLevel, const char* const logMessage);
  11. // Register the custom logging callback with wolfSSL
  12. ret = wolfSSL_SetLoggingCb(MyLoggingCallback);
  13. if (ret != 0) {
  14. // failed to set logging callback
  15. }
  16. void MyLoggingCallback(const int logLevel, const char* const logMessage)
  17. {
  18. // custom logging function
  19. }
  20. \endcode
  21. \sa wolfSSL_Debugging_ON
  22. \sa wolfSSL_Debugging_OFF
  23. */
  24. int wolfSSL_SetLoggingCb(wolfSSL_Logging_cb log_function);
  25. /*!
  26. \ingroup Debug
  27. \brief ビルド時にロギングが有効になっている場合、この関数は実行時にロギングをオンにします。ビルド時にログ記録を有効にするには--enable-debugまたはdebug_wolfsslを定義します。
  28. \return 0 成功すると。
  29. \return NOT_COMPILED_IN このビルドに対してロギングが有効になっていない場合は返されるエラーです。
  30. _Example_
  31. \code
  32. wolfSSL_Debugging_ON();
  33. \endcode
  34. \sa wolfSSL_Debugging_OFF
  35. \sa wolfSSL_SetLoggingCb
  36. */
  37. int wolfSSL_Debugging_ON(void);
  38. /*!
  39. \ingroup Debug
  40. \brief この関数はランタイムロギングメッセージをオフにします。彼らがすでに消えている場合は、行動はとられません。
  41. \return none いいえ返します。
  42. _Example_
  43. \code
  44. wolfSSL_Debugging_OFF();
  45. \endcode
  46. \sa wolfSSL_Debugging_ON
  47. \sa wolfSSL_SetLoggingCb
  48. */
  49. void wolfSSL_Debugging_OFF(void);