/usr/share/gtk-doc/html/gypsy/gypsy-gypsy-control.html is in libgypsy-doc 0.8-0ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GypsyControl</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Gypsy Reference Manual">
<link rel="up" href="ch02.html" title="Gypsy-Daemon Control">
<link rel="prev" href="ch02.html" title="Gypsy-Daemon Control">
<link rel="next" href="ch03.html" title="GPS Data Objects">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gypsy Reference Manual</th>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gypsy-gypsy-control.synopsis" class="shortcut">Top</a>
|
<a href="#gypsy-gypsy-control.description" class="shortcut">Description</a>
|
<a href="#gypsy-gypsy-control.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="GypsyControl">
<a name="gypsy-gypsy-control"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gypsy-gypsy-control.top_of_page"></a>GypsyControl</span></h2>
<p>GypsyControl — Control object for gypsy-daemon</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gypsy-gypsy-control.synopsis"></a><h2>Synopsis</h2>
<a name="GypsyControl"></a><pre class="synopsis"> <a class="link" href="gypsy-gypsy-control.html#GypsyControl-struct" title="GypsyControl">GypsyControl</a>;
#define <a class="link" href="gypsy-gypsy-control.html#GYPSY-CONTROL-DBUS-SERVICE:CAPS" title="GYPSY_CONTROL_DBUS_SERVICE">GYPSY_CONTROL_DBUS_SERVICE</a>
#define <a class="link" href="gypsy-gypsy-control.html#GYPSY-CONTROL-DBUS-PATH:CAPS" title="GYPSY_CONTROL_DBUS_PATH">GYPSY_CONTROL_DBUS_PATH</a>
#define <a class="link" href="gypsy-gypsy-control.html#GYPSY-CONTROL-DBUS-INTERFACE:CAPS" title="GYPSY_CONTROL_DBUS_INTERFACE">GYPSY_CONTROL_DBUS_INTERFACE</a>
<a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="returnvalue">GypsyControl</span></a> * <a class="link" href="gypsy-gypsy-control.html#gypsy-control-get-default" title="gypsy_control_get_default ()">gypsy_control_get_default</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">char</span> * <a class="link" href="gypsy-gypsy-control.html#gypsy-control-create" title="gypsy_control_create ()">gypsy_control_create</a> (<em class="parameter"><code><a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> *control</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *device_name</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="gypsy-gypsy-control.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GypsyControl
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gypsy-gypsy-control.description"></a><h2>Description</h2>
<p>
<a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> is the object that controls the gypsy-daemon process.
It is a singleton object, meaning that there will only be one instance of it
per application. Once the object has been created (or referenced if it
had already been created for the application) with
<a class="link" href="gypsy-gypsy-control.html#gypsy-control-get-default" title="gypsy_control_get_default ()"><code class="function">gypsy_control_get_default()</code></a>, it can be used to tell gypsy-daemon what GPS
device to connect to with <a class="link" href="gypsy-gypsy-control.html#gypsy-control-create" title="gypsy_control_create ()"><code class="function">gypsy_control_create()</code></a>. This call returns the
D-Bus object path to the GPS object in gypsy-daemon. This object path is then used to
create other objects, such as <a class="link" href="GypsyPosition.html" title="GypsyPosition"><span class="type">GypsyPosition</span></a>, or <a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a>.
</p>
<p>
As gypsy-daemon is able to connect to multiple GPS devices, the one
<a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> can be used to create them, returning a different path for each
GPS device. Gypsy-daemon can connect to both serial port devices which have
an entry in <code class="filename">/dev</code> and Bluetooth devices natively without
the need to use rfcomm to set up a <code class="filename">/dev</code> entry. To do
this you pass either the device path or the Bluetooth address of the device
to <a class="link" href="gypsy-gypsy-control.html#gypsy-control-create" title="gypsy_control_create ()"><code class="function">gypsy_control_create()</code></a>.
</p>
<p>
Once the program has finished with the GPS, the <a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> object should
by unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="symbol">. . .</span>
<span class="symbol"><</span>a <span class="gtkdoc kwc">class</span><span class="symbol">=</span><span class="string">"link"</span> href<span class="symbol">=</span><span class="string">"gypsy-gypsy-control.html#GypsyControl"</span><span class="symbol">></span>GypsyControl<span class="symbol"></</span>a<span class="symbol">> *</span>control<span class="symbol">;</span>
<span class="gtkdoc kwb">char</span> <span class="symbol">*</span>path_bt<span class="symbol">, *</span>path_dev<span class="symbol">;</span>
GError <span class="symbol">*</span>error <span class="symbol">=</span> NULL<span class="symbol">;</span>
<span class="symbol">. . .</span>
control <span class="symbol">=</span> <span class="function"><a href="gypsy-gypsy-control.html#gypsy-control-get-default">gypsy_control_get_default</a></span> <span class="symbol">();</span>
<span class="symbol">/ *</span> Use a Bluetooth device <span class="symbol">* /</span>
path_bt <span class="symbol">=</span> <span class="function"><a href="gypsy-gypsy-control.html#gypsy-control-create">gypsy_control_create</a></span> <span class="symbol">(</span>control<span class="symbol">,</span> <span class="string">"aa:bb:cc:dd:ee"</span><span class="symbol">, &</span>error<span class="symbol">);</span>
<span class="keyword">if</span> <span class="symbol">(</span>path_bt <span class="symbol">==</span> NULL<span class="symbol">) {</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Message-Logging.html#g-warning">g_warning</a></span> <span class="symbol">(</span><span class="string">"There was an error creating aa:bb:cc:dd:ee - %s"</span><span class="symbol">,</span> error<span class="symbol">-></span>message<span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="symbol">(</span>error<span class="symbol">);</span>
error <span class="symbol">=</span> NULL<span class="symbol">;</span>
<span class="symbol">}</span>
<span class="symbol">/ *</span> Use a serial port device <span class="symbol">* /</span>
path_dev <span class="symbol">=</span> <span class="function"><a href="gypsy-gypsy-control.html#gypsy-control-create">gypsy_control_create</a></span> <span class="symbol">(</span>control<span class="symbol">,</span> <span class="string">"/dev/gps"</span><span class="symbol">, &</span>error<span class="symbol">);</span>
<span class="keyword">if</span> <span class="symbol">(</span>path_dev <span class="symbol">==</span> NULL<span class="symbol">) {</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Message-Logging.html#g-warning">g_warning</a></span> <span class="symbol">(</span><span class="string">"There was an error creating /dev/gps - %s"</span><span class="symbol">,</span> error<span class="symbol">-></span>message<span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="symbol">(</span>error<span class="symbol">);</span>
error <span class="symbol">=</span> NULL<span class="symbol">;</span>
<span class="symbol">}</span>
<span class="symbol">. . .</span>
<span class="symbol">/ *</span> Use the paths here to create listener objects <span class="symbol">* /</span>
<span class="symbol">. . .</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free">g_free</a></span> <span class="symbol">(</span>path_bt<span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free">g_free</a></span> <span class="symbol">(</span>path_dev<span class="symbol">);</span>
<span class="symbol">. . .</span>
<span class="symbol">/ *</span> The program has finished with Gypsy now<span class="symbol">,</span> unref the object<span class="symbol">. * /</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="symbol">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span> <span class="symbol">(</span>control<span class="symbol">));</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="gypsy-gypsy-control.details"></a><h2>Details</h2>
<div class="refsect2" title="GypsyControl">
<a name="GypsyControl-struct"></a><h3>GypsyControl</h3>
<pre class="programlisting">typedef struct _GypsyControl GypsyControl;</pre>
<p>
There are no public fields in <a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_CONTROL_DBUS_SERVICE">
<a name="GYPSY-CONTROL-DBUS-SERVICE:CAPS"></a><h3>GYPSY_CONTROL_DBUS_SERVICE</h3>
<pre class="programlisting">#define GYPSY_CONTROL_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the service name of the control service
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_CONTROL_DBUS_PATH">
<a name="GYPSY-CONTROL-DBUS-PATH:CAPS"></a><h3>GYPSY_CONTROL_DBUS_PATH</h3>
<pre class="programlisting">#define GYPSY_CONTROL_DBUS_PATH "/org/freedesktop/Gypsy"
</pre>
<p>
A define containing the object path of the Gypsy object
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_CONTROL_DBUS_INTERFACE">
<a name="GYPSY-CONTROL-DBUS-INTERFACE:CAPS"></a><h3>GYPSY_CONTROL_DBUS_INTERFACE</h3>
<pre class="programlisting">#define GYPSY_CONTROL_DBUS_INTERFACE "org.freedesktop.Gypsy.Server"
</pre>
<p>
A define containing the name of the Control interface
</p>
</div>
<hr>
<div class="refsect2" title="gypsy_control_get_default ()">
<a name="gypsy-control-get-default"></a><h3>gypsy_control_get_default ()</h3>
<pre class="programlisting"><a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="returnvalue">GypsyControl</span></a> * gypsy_control_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieves the default <a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A singleton <a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a>. Once the program has finished using
the <a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a>, it should be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_control_create ()">
<a name="gypsy-control-create"></a><h3>gypsy_control_create ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * gypsy_control_create (<em class="parameter"><code><a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> *control</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *device_name</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a object on the server that refers to the GPS device at <em class="parameter"><code>device_name</code></em>.
When this object is finalized, the remote object on the server will be
shutdown after which any calls to the object at the returned path
are not guaranteed to work.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>control</code></em> :</span></p></td>
<td>The <a class="link" href="gypsy-gypsy-control.html#GypsyControl"><span class="type">GypsyControl</span></a> device
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>device_name</code></em> :</span></p></td>
<td>The path to the device file, or Bluetooth address
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to return errors in, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The path to the created object.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|