ST / ST_Events-old

This is a fork of the `events` subdirectory of https://github.com/ARMmbed/mbed-os

Dependents:   HelloWorld_CCA01M1 HelloWorld_CCA02M1 CI-data-logger-server HelloWorld_CCA02M1 ... more

This is a fork of the events subdirectory of https://github.com/ARMmbed/mbed-os.

Note, you must import this library with import name: events!!!

Files at this revision

API Documentation at this revision

Revision 15:42ba4ffdf78d, committed 2017-02-17

Comitter:
Christopher Haster
Date:
Fri Feb 17 14:33:09 2017 -0600
Parent:
14:65535458dd6f
Child:
17:26f21b1871a7
Commit message:
events: Added better documentation for binding types to events

Changed in this revision

Event.h Show annotated file Show diff for this revision Revisions of this file
EventQueue.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Event.h	Wed Feb 15 13:43:52 2017 -0600
+++ b/Event.h	Fri Feb 17 14:33:09 2017 -0600
@@ -45,7 +45,10 @@
      *
      *  @param q        Event queue to dispatch on
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      */
     template <typename F>
     Event(EventQueue *q, F f) {
@@ -438,7 +441,10 @@
      *
      *  @param q        Event queue to dispatch on
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      */
     template <typename F>
     Event(EventQueue *q, F f) {
@@ -831,7 +837,10 @@
      *
      *  @param q        Event queue to dispatch on
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      */
     template <typename F>
     Event(EventQueue *q, F f) {
@@ -1224,7 +1233,10 @@
      *
      *  @param q        Event queue to dispatch on
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      */
     template <typename F>
     Event(EventQueue *q, F f) {
@@ -1617,7 +1629,10 @@
      *
      *  @param q        Event queue to dispatch on
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      */
     template <typename F>
     Event(EventQueue *q, F f) {
@@ -2010,7 +2025,10 @@
      *
      *  @param q        Event queue to dispatch on
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      */
     template <typename F>
     Event(EventQueue *q, F f) {

--- a/EventQueue.h	Wed Feb 15 13:43:52 2017 -0600
+++ b/EventQueue.h	Fri Feb 17 14:33:09 2017 -0600
@@ -944,7 +944,10 @@
      *  context of the event queue's dispatch loop once posted.
      *
      *  @param f        Function to execute when the event is dispatched
-     *  @param a0..a4   Arguments to pass to the callback
+     *  @param c0..c4   Arguments to bind to the callback, these arguments are
+     *                  allocated on an irq-safe allocator from the event queue's
+     *                  memory pool. Must be type-compatible with b0..b4, the
+     *                  arguments to the underlying callback.
      *  @return         Event that will dispatch on the specific queue
      */
     template <typename R>