comment doc: events are never skipped in read mode for log file provider

git-svn-id: https://lcm.googlecode.com/svn/trunk@549 989093bb-e83e-0410-a25a-9184cbcad8d0
lcm-proj · Jun 2, 2011 · ca9fe7c · ca9fe7c
1 parent de4367e
commit ca9fe7c
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lcm/lcm.h b/lcm/lcm.h
@@ -119,7 +119,9 @@ typedef void (*lcm_msg_handler_t) (const lcm_recv_buf_t *rbuf,
  *         speed = N
  *             Scale factor controlling the playback speed of the log file.
  *             Defaults to 1.  If less than or equal to zero, then the events
- *             in the log file are played back as fast as possible.
+ *             in the log file are played back as fast as possible.  Events are
+ *             never skipped in read mode, so actual playback speed may be slower
+ *             than requested, depending on the handlers.
  *         
  *         mode = r | w
  *             Specifies the log file mode.  Defaults to 'r'