source: rtems-central/spec/rtems/timer/if/reset.yml @ c970d63

Last change on this file since c970d63 was c970d63, checked in by Sebastian Huber <sebastian.huber@…>, on 12/01/20 at 13:57:03

spec: Review Timer Manager API

  • Property mode set to 100644
File size: 1.9 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Resets the timer.
4copyrights:
5- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
6- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
7definition:
8  default:
9    attributes: null
10    body: null
11    params:
12    - ${../../type/if/id:/name} ${.:/params[0]/name}
13    return: ${../../status/if/code:/name}
14  variants: []
15description: |
16  This directive resets the timer specified by ${.:/params[0]/name}.  This
17  timer must have been previously initiated with either the ${fire-after:/name}
18  or ${server-fire-after:/name} directive.  If active the timer is canceled,
19  after which the timer is reinitiated using the same interval and timer
20  service routine which the original ${fire-after:/name} or
21  ${server-fire-after:/name} directive used.
22enabled-by: true
23index-entries:
24- reset a timer
25interface-type: function
26links:
27- role: interface-placement
28  uid: header
29- role: interface-ingroup
30  uid: group
31name: rtems_timer_reset
32notes: |
33  This directive will not cause the running task to be preempted.
34
35  If the timer has not been used or the last usage of this timer was by a
36  ${fire-when:/name} or ${server-fire-when:/name} directive, then the
37  ${../../status/if/not-defined:/name} error is returned.
38
39  Restarting a cancelled after timer results in the timer being reinitiated
40  with its previous timer service routine and interval.
41params:
42- description: is the timer identifier.
43  dir: null
44  name: id
45return:
46  return: null
47  return-values:
48  - description: |
49      The requested operation was successful.
50    value: ${../../status/if/successful:/name}
51  - description: |
52      There was no timer associated with the identifier specified by
53      ${.:/params[0]/name}.
54    value: ${../../status/if/invalid-id:/name}
55  - description: |
56      The timer was not of the interval class.
57    value: ${../../status/if/not-defined:/name}
58type: interface
Note: See TracBrowser for help on using the repository browser.