|Home > Iris APIs > Iris API documentation|
This book and the Iris Reference Manual use the following conventions when referring to Iris functions and objects:
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.
Function calls in JSON RPC 2.0 either return a result or an error member in the response object. For each function, the Iris Reference Manual describes any Objects that are returned 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.
See Iris Reference Manual for descriptions of Iris interfaces and error codes.
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.