pw_thread_freertos: Update Options class

Change-Id: I2bfec788184051266d0003b250e749e9fb076046 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/107337 Reviewed-by: Armando Montanez <[email protected]> Reviewed-by: Wyatt Hepler <[email protected]> Commit-Queue: Medha Kini <[email protected]>
google · Aug 20, 2022 · 4c01e58 · 4c01e58
1 parent 2841e8e
commit 4c01e58
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/pw_thread_freertos/public/pw_thread_freertos/options.h b/pw_thread_freertos/public/pw_thread_freertos/options.h
@@ -86,13 +86,19 @@ class Options : public thread::Options {
     return *this;
   }
 
+  // Returns name of FreeRTOS task.
+  //
+  // Note that this thread name may not match the actual thread name. See the
+  // FreeRTOS documentation on how names must be <= configMAX_TASK_NAME_LEN in
+  // order to avoid truncation.
+  const char* name() const { return name_; }
+
  private:
   friend thread::Thread;
   // FreeRTOS requires a valid name when asserts are enabled,
   // configMAX_TASK_NAME_LEN may be as small as one character.
   static constexpr char kDefaultName[] = "pw::Thread";
 
-  const char* name() const { return name_; }
   UBaseType_t priority() const { return priority_; }
 #if PW_THREAD_FREERTOS_CONFIG_DYNAMIC_ALLOCATION_ENABLED
   size_t stack_size_words() const { return stack_size_words_; }