source: rtems-central/spec/rtems/sem/if/ident.yml @ 0500b9a

Last change on this file since 0500b9a was 0500b9a, checked in by Sebastian Huber <sebastian.huber@…>, on 12/01/20 at 13:23:41

interface/interfacedoc: Format parameter names

  • Property mode set to 100644
File size: 3.1 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Identifies a semaphore object by the specified object name.
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/name:/name} ${.:/params[0]/name}
13    - ${/c/if/uint32_t:/name} ${.:/params[1]/name}
14    - ${../../type/if/id:/name} *${.:/params[2]/name}
15    return: ${../../status/if/code:/name}
16  variants: []
17description: |
18  This directive obtains the semaphore identifier associated with the semaphore
19  name specified in ${.:/params[0]/name}.
20
21  The node to search is specified in ${.:/params[1]/name}.  It shall be
22
23  * a valid node number,
24
25  * the constant ${../../object/if/search-all-nodes:/name} to search in all nodes,
26
27  * the constant ${../../object/if/search-local-node:/name} to search in the local
28    node only, or
29
30  * the constant ${../../object/if/search-other-nodes:/name} to search in all nodes
31    except the local node.
32enabled-by: true
33index-entries: []
34interface-type: function
35links:
36- role: interface-placement
37  uid: header
38- role: interface-ingroup
39  uid: group
40name: rtems_semaphore_ident
41notes: |
42  If the semaphore name is not unique, then the semaphore identifier will match
43  the first semaphore with that name in the search order.  However, this
44  semaphore identifier is not guaranteed to correspond to the desired
45  semaphore.  The semaphore identifier is used with other semaphore related
46  directives to access the semaphore.
47
48  If node is ${../../object/if/search-all-nodes:/name}, all nodes are searched with
49  the local node being searched first.  All other nodes are searched with the
50  lowest numbered node searched first.
51
52  If node is a valid node number which does not represent the local node, then
53  only the semaphores exported by the designated node are searched.
54
55  This directive does not generate activity on remote nodes.  It accesses only
56  the local copy of the global object table.
57params:
58- description: is the object name to look up.
59  dir: null
60  name: name
61- description: is the node or node set to search for a matching object.
62  dir: null
63  name: node
64- description: |
65    is the pointer to an object identifier variable.  The object identifier of
66    an object with the specified name will be stored in this variable, in case
67    of a successful operation.
68  dir: out
69  name: id
70return:
71  return: null
72  return-values:
73  - description: |
74      The requested operation was successful.
75    value: ${../../status/if/successful:/name}
76  - description: |
77      The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
78    value: ${../../status/if/invalid-address:/name}
79  - description: |
80      The ${.:/params[0]/name} parameter was 0.
81    value: ${../../status/if/invalid-name:/name}
82  - description: |
83      There was no object with the specified name on the specified nodes.
84    value: ${../../status/if/invalid-name:/name}
85  - description: |
86      In multiprocessing configurations, the specified node was invalid.
87    value: ${../../status/if/invalid-node:/name}
88type: interface
Note: See TracBrowser for help on using the repository browser.