5.1 Iris API documentation

This book uses the following conventions when referring to Iris functions and objects:

Intuitive type names

Objects that are used as arguments and return values have intuitive type names, for example RegisterInfo. These type names do not occur in the requests or responses themselves, but are used in the documentation to help to clarify the purpose and context of the data. They also define a name for derived interfaces like C++, which support type names.

Return values

Function calls in JSON RPC 2.0 either return a result or an error member in the response object. For each function, the documentation describes any Objects that it returns in the result and lists any function-specific error codes that it can return. All functions can also return one of the general error codes, which are not listed in the function documentation, for brevity.

Function call parentheses

The Iris documentation uses the syntax foo() to refer to a function called foo, although the trailing parentheses do not appear anywhere in JSON or in U64JSON-formatted function calls. The parentheses are used to intuitively identify function names. In practice, Iris functions are called by language bindings, for instance C++ or Python functions, which use the syntax with parentheses.

Non-ConfidentialPDF file icon PDF version101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.