Changeset 90969 in vbox for trunk/include

Timestamp:

Aug 27, 2021 10:12:22 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

146608

Message:

IPRT/log: Defined the multibuffer flush protocol. bugref:10086

File:

• trunk/include/iprt/log.h (modified) (3 diffs)

trunk/include/iprt/log.h

@@ -197 +197 @@
  * Custom buffer flushing function.
  *
- * @retval  true if flushed.
- * @retval  false if flushing pending on other thread and the logger should
- *          switch to the next buffer.  The other thread will call
- *          RTLogFlushDone when finished.
+ * @retval  true if flushed and the buffer can be reused.
+ * @retval  false for switching to the next buffer because an async flush of
+ *          @a pBufDesc is still pending.  The implementation is responsible for
+ *          only returning when the next buffer is ready for reuse, the generic
+ *          logger code has no facility to make sure of this.
+ *
  * @param   pLogger     Pointer to the logger instance which is to be flushed.
  * @param   pBufDesc    The descriptor of the buffer to be flushed.
@@ -288 +290 @@
 
 /** RTLOGBUFFERDESC::u32Magic value. (Avram Noam Chomsky) */
-# define RTLOGBUFFERDESC_MAGIC   UINT32_C(0x19281207)
+#define RTLOGBUFFERDESC_MAGIC   UINT32_C(0x19281207)
 
 /**
@@ -321 +323 @@
 
 /** RTLOGGER::u32Magic value. (John Rogers Searle) */
-#define RTLOGGER_MAGIC      UINT32_C(0x19320731)
+#define RTLOGGER_MAGIC          UINT32_C(0x19320731)
 
 /**