[libgdata] [docs] Added data flow diagram and protocol description
- From: Philip Withnall <pwithnall src gnome org>
- To: svn-commits-list gnome org
- Subject: [libgdata] [docs] Added data flow diagram and protocol description
- Date: Sun, 28 Jun 2009 16:35:09 +0000 (UTC)
commit dad5356795c230886e11d8a63fbd4fc27596b2f4
Author: Philip Withnall <philip tecnocode co uk>
Date: Sun Jun 28 17:34:33 2009 +0100
[docs] Added data flow diagram and protocol description
docs/reference/data-flow.dia | Bin 0 -> 1657 bytes
docs/reference/data-flow.png | Bin 0 -> 24681 bytes
docs/reference/gdata-overview.xml | 19 +++++++++++++++++++
docs/reference/structure.dia | Bin 1814 -> 1803 bytes
docs/reference/structure.png | Bin 17149 -> 22102 bytes
5 files changed, 19 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/data-flow.dia b/docs/reference/data-flow.dia
new file mode 100644
index 0000000..9b1155b
Binary files /dev/null and b/docs/reference/data-flow.dia differ
diff --git a/docs/reference/data-flow.png b/docs/reference/data-flow.png
new file mode 100644
index 0000000..d1ff178
Binary files /dev/null and b/docs/reference/data-flow.png differ
diff --git a/docs/reference/gdata-overview.xml b/docs/reference/gdata-overview.xml
index d431c56..dea9650 100644
--- a/docs/reference/gdata-overview.xml
+++ b/docs/reference/gdata-overview.xml
@@ -16,6 +16,25 @@
data on the web, designed by Google.</para>
<refsect2>
+ <title>Protocol</title>
+ <para>The GData protocol is designed by Google to allow interaction with their web services. It is based on the Atom Publishing
+ protocol, with namespaced XML additions. Communication between the client and server is broadly achieved through HTTP
+ requests with query parameters, and Atom feeds being returned with result entries. Each <firstterm>service</firstterm>
+ has its own namespaced additions to the GData protocol; for example, the Google Calendar service's API has
+ specialisations for addresses and time periods.
+ <figure>
+ <mediaobject>
+ <imageobject><imagedata fileref="data-flow.png" format="PNG" align="center"/></imageobject>
+ </mediaobject>
+ <textobject><phrase>An overview of the data flow when making a request of a GData service.</phrase></textobject>
+ </figure>
+ </para>
+ <para>Results are always returned in the form of result <firstterm>feeds</firstterm>, containing multiple
+ <firstterm>entries</firstterm>. How the entries are interpreted depends on what was queried of the service, but when
+ using libgdata, this is all taken care of transparently.</para>
+ </refsect2>
+
+ <refsect2>
<title>Structure</title>
<para>The basic design of libgdata mirrors the protocol's structure quite closely:
<figure>
diff --git a/docs/reference/structure.dia b/docs/reference/structure.dia
index 3b39c69..4d35938 100644
Binary files a/docs/reference/structure.dia and b/docs/reference/structure.dia differ
diff --git a/docs/reference/structure.png b/docs/reference/structure.png
index 25f3b5d..07c0352 100644
Binary files a/docs/reference/structure.png and b/docs/reference/structure.png differ
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]