summaryrefslogtreecommitdiff
path: root/doc/design.txt
diff options
context:
space:
mode:
authorWim Taymans <wtaymans@redhat.com>2015-08-26 12:46:28 +0200
committerWim Taymans <wtaymans@redhat.com>2015-08-26 12:46:28 +0200
commit0e03080002ea7942ba545205f1e4127aa7c7ff1e (patch)
treea6fffb653f95703fb0819c3dd4316c141ef2b883 /doc/design.txt
parent4e92d3254072d2c465304c15b4f859e35c99fec4 (diff)
Rework buffer API a little
Use BufferIter and BufferBuilder instead of Packet* Make separate method to set the header so you can set it later and not only at builder init time. Add method to clear the builder if you want to abort. Add method to add fd to builder instead of in _add_fd_payload. This would make it easier to add multiple fd-payloads using data from the same fd. Pass PinosPacketFDPayload to add_fd_payload to make it symetric with the parsing code. We should be able to get the size from the VERSION passed when the builder was made. Add ideas about releasing the fds back to the server.
Diffstat (limited to 'doc/design.txt')
-rw-r--r--doc/design.txt13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/design.txt b/doc/design.txt
index 4db76349..242320d3 100644
--- a/doc/design.txt
+++ b/doc/design.txt
@@ -71,17 +71,26 @@ Types:
0: fd-payload section
+ Used to send a buffer between client and server.
+
+ <id> : 4 bytes : id of the fd-payload
<offset> : 8 bytes : offset
<size> : 8 bytes : size
<fd-index> : 4 bytes : index of fd
- 1: format change
+ 1: release fd-payload
+
+ Release a fd-payload with <id>
+
+ <id> : 4 bytes : the id number of the released fd-payload
+
+ 2: format change
<format-id> : 1 byte : format id
<format> : 0-terminated : contains serialized format
- 2: property changes
+ 3: property changes
<key> : 0-terminated : key
<value> : 0-terminated : value