~zeitgeist-packagers/libzeitgeist/ubuntu

« back to all changes in this revision

Viewing changes to src/docbook-struct-Event.xml

  • Committer: Sebastien Bacher
  • Date: 2010-12-17 11:24:32 UTC
  • mfrom: (130.2.8 upstream)
  • Revision ID: seb128@ubuntu.com-20101217112432-fvpa4ogpotl4k0pz
* New upstream version
* debian/control: 
  - don't use libeggdbus, update the requirement on libglib for gdbus
  - updated for the new soname
* Updated the .install and the .symbols for the new soname

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2 //EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="eggdbus-structmain-Event">
5
 
  <refmeta>
6
 
    <refentrytitle role="top_of_page">Event Structure</refentrytitle>
7
 
  </refmeta>
8
 
  <refnamediv>
9
 
    <refname>Event Structure</refname>
10
 
    <refpurpose>Event</refpurpose>
11
 
  </refnamediv>
12
 
  <refsect1>
13
 
    <refsect2 role="struct" id="eggdbus-struct-Event">
14
 
      <title>The Event Structure</title>
15
 
        <para>
16
 
          <programlisting>
17
 
{
18
 
  Array&lt;String&gt;        event_data,
19
 
  Array&lt;Array&lt;String&gt;&gt; subjects,
20
 
  Array&lt;Byte&gt;          payload
21
 
}
22
 
          </programlisting>
23
 
          <para>
24
 
The <link linkend="eggdbus-struct-Event">Event</link> type is used to represent events or event templates
25
 
          </para>
26
 
          <variablelist role="struct">
27
 
  <varlistentry>
28
 
    <term><literal>Array&lt;String&gt; <structfield>event_data</structfield></literal></term>
29
 
    <listitem>
30
 
      <para>
31
 
Event metadata
32
 
      </para>
33
 
    </listitem>
34
 
  </varlistentry>
35
 
  <varlistentry>
36
 
    <term><literal>Array&lt;Array&lt;String&gt;&gt; <structfield>subjects</structfield></literal></term>
37
 
    <listitem>
38
 
      <para>
39
 
Array of event subjects
40
 
      </para>
41
 
    </listitem>
42
 
  </varlistentry>
43
 
  <varlistentry>
44
 
    <term><literal>Array&lt;Byte&gt; <structfield>payload</structfield></literal></term>
45
 
    <listitem>
46
 
      <para>
47
 
Event payload - free form binary data attached to the event at logging time
48
 
      </para>
49
 
    </listitem>
50
 
  </varlistentry>
51
 
          </variablelist>
52
 
        </para>
53
 
    </refsect2>
54
 
  </refsect1>
55
 
</refentry>