pxcloud/spice-common
6
0
Fork 0
mirror of https://gitlab.uni-freiburg.de/opensourcevdi/spice-common synced 2026-08-08 11:58:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

More work on attribute protocol documentation

Browse Source 
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
This commit is contained in:
Frediano Ziglio 2016-09-19 14:11:51 +01:00
parent 7773c0d59b
commit 4673a61cce
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/spice_protocol.txt
View File

@ -336,12 +336,21 @@ TODO
nomarshal
~~~~~~~~~
TODO
Do not generate code for marshalling this variable.
Usually used on last array element to make possible to manually feed data.
Example:
struct Data {
uint32 data_size;
uint8 data[data_size] @nomarshal;
};
zero_terminated
~~~~~~~~~~~~~~~
TODO
The field should terminated by zero.
Actually it's not used by python code so it's not enforced and no
code is generated.
marshall
~~~~~~~~
@ -351,12 +360,16 @@ TODO
nonnull
~~~~~~~
TODO
This pointer field cannot be NULL. This means that marshaller assume C structure
contain not NULL pointer and demarshaller will fail to demarshall message if offset
is 0.
unique_flag
~~~~~~~~~~~
TODO
This flag field should contain just a single flag.
Actually it's not used by python code so it's not enforced and no
code is generated.
ptr_array
~~~~~~~~~