Raul Martin / EventFramework Featured

EventFramework library allows the creation of an event-driven infrastructure in which small "threads" can handle events in a multithreaded execution context. The EventFramework can be configured to act as a cooperative or a fully-preemptive kernel with fixed-priority scheduling. Furthermore, this kernel matches run-to-completion semantics, and hence a single-stack configuration is enough to keep running this multithreaded execution environment. As running threads shares global stack, a huge quantity of RAM is saved in contrast with traditional RTOSes.

Dependents:   sensors_KL46Z_xmn

Node/Node.h@1:ec12f2e32faf, 2012-10-03 (annotated)

Committer:
raulMrello
Date:
Wed Oct 03 21:02:16 2012 +0000
Revision:
1:ec12f2e32faf
Parent:
0:9d09acc8f9d9 
Nesting correction on RestoreContext interface.; Erase invalid comment-block

Who changed what in which revision?

UserRevisionLine numberNew contents of line
raulMrello 0:9d09acc8f9d9 1 /* mbed EventFramework Library
raulMrello 0:9d09acc8f9d9 2 * Copyright (c) 2012 raulMrello
raulMrello 0:9d09acc8f9d9 3 *
raulMrello 0:9d09acc8f9d9 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
raulMrello 0:9d09acc8f9d9 5 * of this software and associated documentation files (the "Software"), to deal
raulMrello 0:9d09acc8f9d9 6 * in the Software without restriction, including without limitation the rights
raulMrello 0:9d09acc8f9d9 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
raulMrello 0:9d09acc8f9d9 8 * copies of the Software, and to permit persons to whom the Software is
raulMrello 0:9d09acc8f9d9 9 * furnished to do so, subject to the following conditions:
raulMrello 0:9d09acc8f9d9 10 *
raulMrello 0:9d09acc8f9d9 11 * The above copyright notice and this permission notice shall be included in
raulMrello 0:9d09acc8f9d9 12 * all copies or substantial portions of the Software.
raulMrello 0:9d09acc8f9d9 13 *
raulMrello 0:9d09acc8f9d9 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
raulMrello 0:9d09acc8f9d9 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
raulMrello 0:9d09acc8f9d9 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
raulMrello 0:9d09acc8f9d9 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
raulMrello 0:9d09acc8f9d9 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
raulMrello 0:9d09acc8f9d9 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
raulMrello 0:9d09acc8f9d9 20 * THE SOFTWARE.
raulMrello 0:9d09acc8f9d9 21 */
raulMrello 0:9d09acc8f9d9 22
raulMrello 0:9d09acc8f9d9 23 #ifndef _NODE_H_
raulMrello 0:9d09acc8f9d9 24 #define _NODE_H_
raulMrello 0:9d09acc8f9d9 25
raulMrello 0:9d09acc8f9d9 26 #include "../Types/Types.h"
raulMrello 0:9d09acc8f9d9 27
raulMrello 0:9d09acc8f9d9 28 /** Node class
raulMrello 0:9d09acc8f9d9 29 *
raulMrello 0:9d09acc8f9d9 30 * Node objects are elements contained in a List, and linked to the previous and
raulMrello 0:9d09acc8f9d9 31 * next one. A Node can contain attached data as and object reference. It's a
raulMrello 0:9d09acc8f9d9 32 * utility class in the Framework to create Queues.
raulMrello 0:9d09acc8f9d9 33 *
raulMrello 0:9d09acc8f9d9 34 */
raulMrello 0:9d09acc8f9d9 35 class Node{
raulMrello 0:9d09acc8f9d9 36 public:
raulMrello 0:9d09acc8f9d9 37
raulMrello 0:9d09acc8f9d9 38 /** Creates a Node with a specified item attached.
raulMrello 0:9d09acc8f9d9 39 *
raulMrello 0:9d09acc8f9d9 40 * @param item data object reference to attach to this Node.
raulMrello 0:9d09acc8f9d9 41 */
raulMrello 0:9d09acc8f9d9 42 Node(void* item);
raulMrello 0:9d09acc8f9d9 43 Node();
raulMrello 0:9d09acc8f9d9 44 ~Node();
raulMrello 0:9d09acc8f9d9 45
raulMrello 0:9d09acc8f9d9 46 /** Sets the reference to the next Node in the list.
raulMrello 0:9d09acc8f9d9 47 *
raulMrello 0:9d09acc8f9d9 48 * @param node node reference to the next node.
raulMrello 0:9d09acc8f9d9 49 */
raulMrello 0:9d09acc8f9d9 50 void SetNext(Node* node);
raulMrello 0:9d09acc8f9d9 51
raulMrello 0:9d09acc8f9d9 52 /** Sets the reference to the previous Node in the list.
raulMrello 0:9d09acc8f9d9 53 *
raulMrello 0:9d09acc8f9d9 54 * @param node node reference to the previous node.
raulMrello 0:9d09acc8f9d9 55 */
raulMrello 0:9d09acc8f9d9 56 void SetPrev(Node* node);
raulMrello 0:9d09acc8f9d9 57
raulMrello 0:9d09acc8f9d9 58 /** Gets the reference to the next Node in the list.
raulMrello 0:9d09acc8f9d9 59 *
raulMrello 0:9d09acc8f9d9 60 * @returns node reference to the next node.
raulMrello 0:9d09acc8f9d9 61 */
raulMrello 0:9d09acc8f9d9 62 Node* GetNext(void);
raulMrello 0:9d09acc8f9d9 63
raulMrello 0:9d09acc8f9d9 64 /** Gets the reference to the previous Node in the list.
raulMrello 0:9d09acc8f9d9 65 *
raulMrello 0:9d09acc8f9d9 66 * @returns node reference to the previous node.
raulMrello 0:9d09acc8f9d9 67 */
raulMrello 0:9d09acc8f9d9 68 Node* GetPrev(void);
raulMrello 0:9d09acc8f9d9 69
raulMrello 0:9d09acc8f9d9 70 /** Sets the attached data object item in the Node
raulMrello 0:9d09acc8f9d9 71 *
raulMrello 0:9d09acc8f9d9 72 * @param item data object reference to attach to this Node.
raulMrello 0:9d09acc8f9d9 73 */
raulMrello 0:9d09acc8f9d9 74 void SetData(void* item);
raulMrello 0:9d09acc8f9d9 75
raulMrello 0:9d09acc8f9d9 76 /** Gets the reference to the attached data object
raulMrello 0:9d09acc8f9d9 77 *
raulMrello 0:9d09acc8f9d9 78 * @returns attached data object reference.
raulMrello 0:9d09acc8f9d9 79 */
raulMrello 0:9d09acc8f9d9 80 void* GetData(void);
raulMrello 0:9d09acc8f9d9 81
raulMrello 0:9d09acc8f9d9 82 private:
raulMrello 0:9d09acc8f9d9 83 Node* prev;
raulMrello 0:9d09acc8f9d9 84 Node* next;
raulMrello 0:9d09acc8f9d9 85 void* data;
raulMrello 0:9d09acc8f9d9 86 };
raulMrello 0:9d09acc8f9d9 87
raulMrello 0:9d09acc8f9d9 88 #endif