Skip to content

Commit bf24bd8

Browse files
authored
Rename dispatch() to dispatch_for()
To better align with other Mbed functions.
1 parent 701c791 commit bf24bd8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

events/include/events/EventQueue.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,14 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
8888

8989
/** Dispatch events
9090
*
91-
* Executes events until the specified milliseconds have passed.
91+
* Executes events for the specified number of milliseconds.
9292
*
93-
* The dispatch function is guaranteed to terminate after the elapsed wait
93+
* The dispatch_for() function is guaranteed to terminate after the elapsed wait.
9494
*
9595
* @param ms Time to wait for events in milliseconds, expressed as a
9696
* Chrono duration.
9797
*/
98-
void dispatch(duration ms);
98+
void dispatch_for(duration ms);
9999

100100
/** Dispatch events
101101
*
@@ -111,7 +111,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
111111
* value will dispatch events indefinitely
112112
* (default to -1)
113113
*/
114-
MBED_DEPRECATED_SINCE("mbed-os-6.7.0", "Pass a chrono duration, not an integer millisecond count. For example use `5s` rather than `5000`.")
114+
MBED_DEPRECATED_SINCE("mbed-os-6.7.0", "Use dispatch_for() to pass a chrono duration, not an integer millisecond count. For example use `5s` rather than `5000`.")
115115
void dispatch(int ms = -1);
116116

117117
/** Dispatch events without a timeout

0 commit comments

Comments
 (0)