Lines Matching refs:an
67 syntax in an EBNF-like notation:
155 self-contained, but at the moment, nothing prevents an included file
157 an outer file. The parser may be made stricter in the future to
223 Nothing prevents an empty enumeration, although it is probably not
226 On the wire, an enumeration type's value is represented by its
227 (string) name. In C, it's represented by an enumeration constant.
236 QAPI schema order), where N is the number of values. There is an
239 Do not use string or an integer type when an enumeration type can do
261 A one-element array containing a string denotes an array of the type
262 named by the string. Example: ``['int']`` denotes an array of ``int``.
287 The MEMBER's STRING name consists of an optional ``*`` prefix and the
298 A struct type corresponds to a struct in C, and an object in JSON.
349 If no such branch exists, an empty branch is assumed.
361 In the Client JSON Protocol, a union is represented by an object with
473 Member 'data' defines the arguments. It defaults to an empty MEMBERS_
482 Member 'returns' defines the command's return type. It defaults to an
483 empty struct type. It must normally be a complex type or an array of
520 complex argument type. It takes an additional ``Error **`` argument in
524 arguments for the user's function out of an input QDict, calls the
525 user's function, and if it succeeded, builds an output QObject from
544 response is not possible (although the command will still return an
598 waiting for an external event (such as I/O completion) in order to avoid
618 It is an error to specify both ``'coroutine': true`` and ``'allow-oob': true``
648 Member 'data' defines the event-specific data. It defaults to an
693 that previously resulted in an error). QMP clients may still need to
793 All definitions take an optional 'if' member. Its value must be a
794 string, or an object with a single member 'all', 'any' or 'not'.
796 The C code generated for the definition will then be guarded by an #if
797 preprocessing directive with an operand generated from that condition:
830 Example: an enum type with unconditional value 'foo' and conditional
848 compile with an arbitrary combination of conditions, since the
911 ``*`` starts an itemized list::
936 Use ``@foo`` to reference a name in the schema. This is an rST
973 followed by an optional overview, a description of each argument (for
1015 "Errors" sections should be formatted as an rST list, each entry
1197 via an enum type; or a member may be converted from a specific type to
1198 an alternate that represents a choice between the original type and
1215 schema, along with the SchemaInfo type. This text attempts to give an
1250 If the command takes no arguments, "arg-type" names an object type
1252 names an object type without members.
1259 Type "q_empty" is an automatic object type without members, and type
1262 The SchemaInfo for an event has meta-type "event", and variant member
1263 "arg-type". On the wire, a "data" member that the server passes in an
1266 If the event carries no additional information, "arg-type" names an
1271 QAPI schema implicitly defines an object type.
1278 Type "q_obj-EVENT_C-arg" is an implicitly defined object type with
1318 tag this element applies to) and "type" (the name of an object type
1338 The SchemaInfo for an alternate type has meta-type "alternate", and
1351 The SchemaInfo for an array type has meta-type "array", and variant
1363 The SchemaInfo for an enumeration type has meta-type "enum" and
1413 union and alternate branches; turning an argument type into an
1421 The specified behavior of an absent optional argument should remain
1423 flexibility; for example, when an optional 'buffer-size' argument is
1444 Any change to a command definition's 'return', an event definition's
1472 As an example, we'll use the following schema, which describes a
1512 The $(prefix) is an optional parameter used as a namespace to keep the
1616 well as for deallocating memory for an existing C type
1903 Implementation of functions to send an event