← Back to branch summary

~ubuntu-branches/ubuntu/precise/libzeitgeist/precise-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-08-02 18:22:32 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100802182232-47ohrpyfxep802pr
Tags: 0.2.3-0ubuntu1
* New upstream release.
  - New API to talk to the Data Source Registry extension of Zeitgeist
    (Michal Hruby)
  - A new "connected" property on ZeitgeistLog telling you whether or
    not the Zeitgeist daemon is running (Michal Hruby)
  - Fix a crasher when finalizing a ZeitgeistLog with active monitors
    installed (Michal Hruby)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/docbook-struct-DataSource.xml
 
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-DataSource">
 
5
  <refmeta>
 
6
    <refentrytitle role="top_of_page">DataSource Structure</refentrytitle>
 
7
  </refmeta>
 
8
  <refnamediv>
 
9
    <refname>DataSource Structure</refname>
 
10
    <refpurpose>DataSource</refpurpose>
 
11
  </refnamediv>
 
12
  <refsect1>
 
13
    <refsect2 role="struct" id="eggdbus-struct-DataSource">
 
14
      <title>The DataSource Structure</title>
 
15
        <para>
 
16
          <programlisting>
 
17
{
 
18
  String       unique_id,
 
19
  String       name,
 
20
  String       description,
 
21
  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; event_templates,
 
22
  Boolean      running,
 
23
  Int64        last_seen,
 
24
  Boolean      enabled
 
25
}
 
26
          </programlisting>
 
27
          <para>
 
28
The <link linkend="eggdbus-struct-DataSource">DataSource</link> type is used to represent registered data sources
 
29
          </para>
 
30
          <variablelist role="struct">
 
31
  <varlistentry>
 
32
    <term><literal>String <structfield>unique_id</structfield></literal></term>
 
33
    <listitem>
 
34
      <para>
 
35
Unique ID of the data source
 
36
      </para>
 
37
    </listitem>
 
38
  </varlistentry>
 
39
  <varlistentry>
 
40
    <term><literal>String <structfield>name</structfield></literal></term>
 
41
    <listitem>
 
42
      <para>
 
43
Name of the data source
 
44
      </para>
 
45
    </listitem>
 
46
  </varlistentry>
 
47
  <varlistentry>
 
48
    <term><literal>String <structfield>description</structfield></literal></term>
 
49
    <listitem>
 
50
      <para>
 
51
Description of the data source
 
52
      </para>
 
53
    </listitem>
 
54
  </varlistentry>
 
55
  <varlistentry>
 
56
    <term><literal>Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <structfield>event_templates</structfield></literal></term>
 
57
    <listitem>
 
58
      <para>
 
59
Event templates for this data source
 
60
      </para>
 
61
    </listitem>
 
62
  </varlistentry>
 
63
  <varlistentry>
 
64
    <term><literal>Boolean <structfield>running</structfield></literal></term>
 
65
    <listitem>
 
66
      <para>
 
67
Whether data source is currently running
 
68
      </para>
 
69
    </listitem>
 
70
  </varlistentry>
 
71
  <varlistentry>
 
72
    <term><literal>Int64 <structfield>last_seen</structfield></literal></term>
 
73
    <listitem>
 
74
      <para>
 
75
Timestamp of last action of this data source
 
76
      </para>
 
77
    </listitem>
 
78
  </varlistentry>
 
79
  <varlistentry>
 
80
    <term><literal>Boolean <structfield>enabled</structfield></literal></term>
 
81
    <listitem>
 
82
      <para>
 
83
Whether data source is enabled
 
84
      </para>
 
85
    </listitem>
 
86
  </varlistentry>
 
87
          </variablelist>
 
88
        </para>
 
89
    </refsect2>
 
90
  </refsect1>
 
91
</refentry>