| Wyatt Hepler | f9fb90f | 2020-09-30 18:59:33 -0700 | [diff] [blame] | 1 | .. _module-pw_log_basic: |
| Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 2 | |
| 3 | ------------ |
| 4 | pw_log_basic |
| 5 | ------------ |
| Wyatt Hepler | 2ccde06 | 2020-09-16 21:58:53 -0700 | [diff] [blame] | 6 | ``pw_log_basic`` is a ``pw_log backend`` that sends logs over ``pw_sys_io`` by |
| 7 | default. The destination of ``pw_sys_io`` depends on the ``pw_sys_io`` backend |
| 8 | in use. This is controlled by the ``dir_pw_sys_io_backend`` variable in a |
| 9 | target's ``target_config.gni``. |
| 10 | |
| 11 | The log output may be changed from ``pw_sys_io`` to an arbitrary function by |
| 12 | calling ``pw::log_basic::SetOutput``. |
| 13 | |
| 14 | .. cpp:namespace:: pw::log_basic |
| 15 | |
| Keir Mierle | b191402 | 2021-04-12 09:08:33 -0700 | [diff] [blame] | 16 | .. cpp:function:: void SetOutput(void (*log_output)(std::string_view)) |
| Wyatt Hepler | 2ccde06 | 2020-09-16 21:58:53 -0700 | [diff] [blame] | 17 | |
| 18 | Set the log output function, which defaults ``pw_sys_io::WriteLine``. This |
| 19 | function is called with each formatted log message. |
| Armando Montanez | 0054a9b | 2020-03-13 13:06:24 -0700 | [diff] [blame] | 20 | |
| 21 | This module employs an internal buffer for formatting log strings, and currently |
| 22 | has a fixed size of 150 bytes. Any final log statements that are larger than |
| 23 | 149 bytes (one byte used for a null terminator) will be truncated. |
| 24 | |
| 25 | .. note:: |
| 26 | The documentation for this module is currently incomplete. |