diff options
| author | Wyatt Hepler <hepler@google.com> | 2022-01-26 22:18:44 -0800 |
|---|---|---|
| committer | Wyatt Hepler <hepler@google.com> | 2022-02-01 16:56:19 +0000 |
| commit | 3ecb339aec12dfbc28408738ec1ceff747fc5267 (patch) | |
| tree | 3d009bc7f30438e4a5fbe57517342f1d8b7ff412 /pw_log_rpc/docs.rst | |
| parent | c228f0d45c753ba7219dab750d8b2dedaad6b8cc (diff) | |
| download | pigweed-3ecb339aec12dfbc28408738ec1ceff747fc5267.tar.gz | |
pw_log_rpc: Remove use of pw_rpc channel payload buffer
Provide a buffer for encoding rather than using the deprecated
pw_rpc PayloadBuffer() API.
Change-Id: Id330a4198a820c709f789a2ea93ff45c7710dd36
Bug: 605
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/81700
Reviewed-by: Carlos Chinchilla <cachinchilla@google.com>
Reviewed-by: Armando Montanez <amontanez@google.com>
Diffstat (limited to 'pw_log_rpc/docs.rst')
| -rw-r--r-- | pw_log_rpc/docs.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/pw_log_rpc/docs.rst b/pw_log_rpc/docs.rst index 304b58661..53f3dfc1a 100644 --- a/pw_log_rpc/docs.rst +++ b/pw_log_rpc/docs.rst @@ -150,10 +150,14 @@ channel ID. RpcLogDrainThread ----------------- -The module includes a sample thread that flushes each drain sequentially. Future -work might replace this with enqueueing the flush work on a work queue. The user -can also choose to have different threads flushing individual ``RpcLogDrain``\s -with different priorities. +The module includes a sample thread that flushes each drain sequentially. +``RpcLogDrainThread`` takes an encoding buffer span at construction. +``RpcLogDrainThreadWithBuffer`` takes a template parameter for the buffer size, +which must be large enough to fit at least one log entry. + +Future work might replace this with enqueueing the flush work on a work queue. +The user can also choose to have different threads flushing individual +``RpcLogDrain``\s with different priorities. Calling ``OpenUnrequestedLogStream()`` is a convenient way to set up a log stream that is started without the need to receive an RCP request for logs. |