update LogEvent usage restriction (#31726)

* update LogEvent usage restriction * Restyled by whitespace * Update src/app/EventLogging.h Co-authored-by: Tennessee Carmel-Veilleux <[email protected]> --------- Co-authored-by: Restyled.io <[email protected]> Co-authored-by: Tennessee Carmel-Veilleux <[email protected]>
project-chip · Jun 5, 2024 · 1079320 · 1079320
1 parent d6f2a8a
commit 1079320
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/app/EventLogging.h b/src/app/EventLogging.h
@@ -54,6 +54,10 @@ class EventLogger : public EventLoggingDelegate
  * context tags to be interpreted within the schema identified by
  * `ClusterID` and `EventId`.
  *
+ * The consumer has to either lock the Matter stack lock or queue the event to
+ * the Matter event queue when using LogEvent. This function is not safe to call
+ * outside of the main Matter processing context.
+ *
  * LogEvent has 2 variant, one for fabric-scoped events and one for non-fabric-scoped events.
  * @param[in] aEventData  The event cluster object
  * @param[in] aEndpoint    The current cluster's Endpoint Id