summaryrefslogtreecommitdiff
path: root/examples/cxx/tree/streaming/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cxx/tree/streaming/README')
-rw-r--r--examples/cxx/tree/streaming/README22
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/cxx/tree/streaming/README b/examples/cxx/tree/streaming/README
new file mode 100644
index 0000000..51e5c14
--- /dev/null
+++ b/examples/cxx/tree/streaming/README
@@ -0,0 +1,22 @@
+This example shows how to create an XML document by performing multiple
+serializations of its smaller parts. This can be useful when the
+document is too large to fit into memory or when the other end needs
+to start processing without waiting for the whole document (streaming).
+
+The example consists of the following files:
+
+records.xsd
+ XML Schema which describes a collection of data records.
+
+records.hxx
+records.cxx
+ C++ types that represent the given vocabulary as well as serialization
+ functions. These are generated by XSD from records.xsd.
+
+driver.cxx
+ Driver for the example. It progressively serializes one thousand data
+ record into a file (out.xml).
+
+To run the example simply execute:
+
+$ ./driver