Revision 46471486 doc/classdiagrams/osal.uml

View differences:

doc/classdiagrams/osal.uml
40 40
      'Retrieves the current time.
41 41
    + {method} urtTimeNow (void) : urt_osTime_t
42 42
      'Increase a system time object.
43
    + {method} urtTimeAddUs (time : urt_osTime_t*, offset : uint32_t) : urt_osTime_t*
43
    + {method} urtTimeAddUs (time : urt_osTime_t*, offset : urt_delay_t) : void
44 44
  }
45 45
}
46 46

  
......
96 96
      'Initializes an urt_osTimer_t object.
97 97
    + {method} urtTimerInit (timer : urt_osTimer_t*) : void
98 98
      'Sets the timer to a specified delay with specified callback and arguments.
99
    + {method} urtTimerSet (timer : urt_osTimer_t*, delay : urt_delay_t, callback : urt_osTimerCallback_t*, parameter : void*) : urt_status_t
99
    + {method} urtTimerSet (timer : urt_osTimer_t*, delay : urt_delay_t, callback : urt_osTimerCallback_t*, parameter : void*) : void
100 100
      'Sets the timer to a specified period with specified callback and arguments.
101
    + {method} urtTimerSetPeriodic (timer : urt_osTimer_t*, period : urt_delay_t, callback : urt_osTimerCallback_t*, parameter : void*) : urt_status_t
101
    + {method} urtTimerSetPeriodic (timer : urt_osTimer_t*, period : urt_delay_t, callback : urt_osTimerCallback_t*, parameter : void*) : void
102 102
      'Resets the timer.
103
    + {method} urtTimerReset (timer : urt_osTimer_t*) : urt_status_t
103
    + {method} urtTimerReset (timer : urt_osTimer_t*) : void
104 104
      'Check whether the timer is already armed.
105 105
    + {method} urtTimerIsArmed (timer : urt_osTimer_t*) : bool
106 106
  }
......
164 164
     'Maximum sleep interval in seconds (as float).
165 165
    URT_THREAD_SLEEP_MAX : float
166 166
      'Maximum sleep interval in seconds.
167
    URT_THREAD_SSLEP_MAX : urt_delay_t
167
    URT_THREAD_SSLEP_MAX : unsigned int
168 168
      'Maximum sleep interval in milliseconds.
169
    URT_THREAD_MSLEEP_MAX : urt_delay_t
169
    URT_THREAD_MSLEEP_MAX : unsigned int
170 170
      'Maximum sleep interval in microseconds.
171 171
    URT_THREAD_USLEEP_MAX : urt_delay_t
172 172
    --
......
174 174
    + {method} URT_THREAD_MEMORY (varname, stacksize)
175 175
    ..
176 176
      'Initializes an urt_osThread_t object.
177
    + {method} urtThreadInit (memory : void*, size : size_t, func : urt_osThreadFunction_t*) : urt_osThread_t*
177
    + {method} urtThreadInit (memory : void*, size : size_t, prio : urt_osThreadPrio_t, func : urt_osThreadFunction_t*, arg : void*) : urt_osThread_t*
178 178
      'Starts a thread.
179
    + {method} urtThreadStart (thread : urt_osThread_t*, prio : urt_osThreadPrio_t, arg : void*) : void
179
    + {method} urtThreadStart (thread : urt_osThread_t*) : void
180 180
      'The calling threads yields.
181 181
    + {method} urtThreadYield (void) : void
182 182
      'Retrieves the priority of the calling thread.
183 183
    + {method} urtThreadGetPriority (void) : urt_osThreadPrio_t
184 184
      'Sets the priority of the calling thread.
185 185
    + {method} urtThreadSetPriority (prio : urt_osThreadPrio_t) : void
186
      'Suspends a thread so it will no longer be executed.
187
    + {method} urtThreadSuspend (thread : urt_osThread_t*) : void
188
      'Wakes a suspended thread.
189
    + {method} urtThreadResume (thread : urt_osThread_t*) : urt_status_t
190 186
      'Suspends the calling thread for the specified time.
191 187
    + {method} urtThreadSleep (seconds : float) : void
192 188
      'Suspends the calling thread for the specified time.
193
    + {method} urtThreadSSleep (seconds : urt_delay_t) : void
189
    + {method} urtThreadSSleep (seconds : unsigned int) : void
194 190
      'Suspends the calling thread for the specified time.
195
    + {method} urtThreadMSleep (milliseconds : urt_delay_t) : void
191
    + {method} urtThreadMSleep (milliseconds : unsigned int) : void
196 192
      'Suspends the calling thread for the specified time.
197 193
    + {method} urtThreadUSleep (microseconds : urt_delay_t) : void
198 194
      'Suspends the calling thread until the specified time.
......
259 255
  /' Not a class/type but a set of static event-related functions. '/
260 256
  $function("urt_events") {
261 257
      'Registers a lister to a source.
262
    + {method} urtEventRegister (source : urt_osEventSource_t*, listener : urt_osEventListener_t*, mask : urt_osEventMask_t, flags : urt_osEventFlags_t) : urt_status_t
258
    + {method} urtEventRegister (source : urt_osEventSource_t*, listener : urt_osEventListener_t*, mask : urt_osEventMask_t, flags : urt_osEventFlags_t) : void
263 259
      'Unregisters a listener from a source.
264
    + {method} urtEventUnregister (source _ urt_osEventSource_t*, listener : urt_osEventListener_t*) : urt_status_t
260
    + {method} urtEventUnregister (source _ urt_osEventSource_t*, listener : urt_osEventListener_t*) : void
265 261
      'Blocks the thread until any event occurs or the timeout expires.
266 262
    + {method} urtEventWait (mask : urt_osEventMask_t, type : urt_osEventWait_t, timeout : urt_delay_t) : urt_osEventMask_t
267 263
  }

Also available in: Unified diff