Revision 5198dfae src/urt_core.c

View differences:

src/urt_core.c
53 53
/**
54 54
 * @brief   Get Core status.
55 55
 *
56
 * @return  A status value.
56
 * @return  Current system status.
57 57
 */
58 58
urt_status_t urtCoreGetStatus(void) {return URT_STATUS_OK;}
59 59

  
60 60
/**
61
 * @brief   Start Nodes... .
61
 * @brief   Start threads of all nodes of the Core.
62 62
 */
63 63
void urtCoreStartNodes(void) {return;}
64 64

  
65 65
/**
66
 * @brief   Synchronize ...
66
 * @brief   Synchronize all nodes of the core.
67 67
 *
68
 * @param[in] node  The node to... .
68
 * @param[in] node  Pointer to a node to synchronize. Must not be NULL.
69 69
 *
70
 * @return  A status value.
70
 * @return  Returns URT_STATUS_OK if all nodes are synchronized and proceed.
71
 *          Returns URT_STATUS_SYNC_ERROR if an exception occurred (faulty stage value detected).
72
 *          Returns URT_STATUS_SYNC_PENDING if there are nodes left to synchronize.
73
 *          In the latter case, the node thread must still wait for the control event (proceed) to synchronize.
71 74
 */
72 75
urt_status_t urtCoreSynchronize(urt_node_t* node) {return URT_STATUS_OK;}
73 76

  
74 77
/**
75
 * @brief   Stop nodes... .
78
 * @brief   Stop threads of all nodes of the Core.
76 79
 *
77
 * @param[in] reason  Reason why nodes should be stopped.
80
 * @param[in] reason  The reason why the function was called. For normal shutdown URT_STATUS_OK should be used.
78 81
 *
79
 * @return  A status value.
82
 * @return  Returns URT_STATUS_OK if there was no call with another reason than URT_STATUS_OK before.
83
 *          If the function has been called before with a different reason, that reason is returned.
80 84
 */
81 85
urt_status_t urtCoreStopNodes(urt_status_t reason) {return URT_STATUS_OK;}
82 86

  
83 87
/**
84 88
 * @brief   Get the topic of the Core.
85 89
 *
86
 * @param[in] id  The id of the topic.
90
 * @param[in] id  Identifier of the topic to retrieve.
87 91
 *
88
 * @return  .
92
 * @return  Returns a pointer to the requested service. Returns NULL if no service matches the given ID.
89 93
 */
90 94
urt_topic_t* urtCoreGetTopic(urt_topicid_t id) {return urt_topic_t;}
91 95

  
92 96
/**
93 97
 * @brief   Get the service of the Core.
94 98
 *
95
 * @param[in] id  The id of the service.
99
 * @param[in] id  Identifier of the service to retrieve.
96 100
 *
97
 * @return .
101
 * @return Returns a pointer to the requested service. Returns NULL if no service matches the given ID.
98 102
 */
99 103
urt_service_t urtCoreGetService(urt_serviceid_t id) {return urt_service_t;}
100 104

  

Also available in: Unified diff