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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GypsyControl</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" 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.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="reference" href="rn01.html" title="Gypsy Overview">
<link rel="reference" href="rn02.html" title="Tutorials">
<link rel="chapter" href="ch01.html" title="Programming Gypsy With Python">
<link rel="reference" href="gypsy-server-interfaces.html" title="Gypsy Server Interface">
<link rel="reference" href="gypsy-client-interfaces.html" title="Gypsy Client Interface">
<link rel="reference" href="rn05.html" title="LibGypsy API Reference">
<link rel="chapter" href="ch02.html" title="Gypsy-Daemon Control">
<link rel="chapter" href="ch03.html" title="GPS Data Objects">
</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"><nobr><a href="#id2593087" class="shortcut">Top</a>
 | 
<a href="#id2510682" class="shortcut">Description</a>
 | 
<a href="#id2510658" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GypsyControl"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2593087"></a><span class="refentrytitle">GypsyControl</span>
</h2>
<p>GypsyControl — Control object for gypsy-daemon</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GypsyControl.html#GypsyControl-struct">GypsyControl</a>;
#define <a href="GypsyControl.html#GYPSY-CONTROL-DBUS-SERVICE:CAPS">GYPSY_CONTROL_DBUS_SERVICE</a>
#define <a href="GypsyControl.html#GYPSY-CONTROL-DBUS-PATH:CAPS">GYPSY_CONTROL_DBUS_PATH</a>
#define <a href="GypsyControl.html#GYPSY-CONTROL-DBUS-INTERFACE:CAPS">GYPSY_CONTROL_DBUS_INTERFACE</a>
<a href="GypsyControl.html" title="GypsyControl">GypsyControl</a>* <a href="GypsyControl.html#gypsy-control-get-default">gypsy_control_get_default</a> (void);
char* <a href="GypsyControl.html#gypsy-control-create">gypsy_control_create</a> (<a href="GypsyControl.html" title="GypsyControl">GypsyControl</a> *control,
const char *device_name,
GError **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2510658"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GypsyControl
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2510682"></a><h2>Description</h2>
<p>
<a href="GypsyControl.html" title="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 href="GypsyControl.html#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 href="GypsyControl.html#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 href="GypsyPosition.html" title="GypsyPosition"><span class="type">GypsyPosition</span></a>, or <a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a>.
</p>
<p>
As gypsy-daemon is able to connect to multiple GPS devices, the one
<a href="GypsyControl.html" title="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 href="GypsyControl.html#gypsy-control-create"><code class="function">gypsy_control_create()</code></a>.
</p>
<p>
Once the program has finished with the GPS, the <a href="GypsyControl.html" title="GypsyControl"><span class="type">GypsyControl</span></a> object should
by unreferenced with <code class="function">g_object_unref()</code>.
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
. . .
<a href="GypsyControl.html" title="GypsyControl">GypsyControl</a> *control;
char *path_bt, *path_dev;
GError *error = NULL;
. . .
control = gypsy_control_get_default ();
/ * Use a Bluetooth device * /
path_bt = gypsy_control_create (control, "aa:bb:cc:dd:ee", &error);
if (path_bt == NULL) {
  g_warning ("There was an error creating aa:bb:cc:dd:ee - %s", error->message);
  g_error_free (error);
  error = NULL;
}
/ * Use a serial port device * /
path_dev = gypsy_control_create (control, "/dev/gps", &error);
if (path_dev == NULL) {
  g_warning ("There was an error creating /dev/gps - %s", error->message);
  g_error_free (error);
  error = NULL;
}
. . .
/ * Use the paths here to create listener objects * /
. . .
g_free (path_bt);
g_free (path_dev);
. . .
/ * The program has finished with Gypsy now, unref the object. * /
g_object_unref (G_OBJECT (control));
</pre></div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2593022"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2591885"></a><h3>
<a name="GypsyControl-struct"></a>GypsyControl</h3>
<a class="indexterm" name="id2593152"></a><pre class="programlisting">typedef struct _GypsyControl GypsyControl;</pre>
<p>
There are no public fields in <a href="GypsyControl.html" title="GypsyControl"><span class="type">GypsyControl</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581874"></a><h3>
<a name="GYPSY-CONTROL-DBUS-SERVICE:CAPS"></a>GYPSY_CONTROL_DBUS_SERVICE</h3>
<a class="indexterm" name="id2581885"></a><pre class="programlisting">#define GYPSY_CONTROL_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the service name of the control service</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581906"></a><h3>
<a name="GYPSY-CONTROL-DBUS-PATH:CAPS"></a>GYPSY_CONTROL_DBUS_PATH</h3>
<a class="indexterm" name="id2581917"></a><pre class="programlisting">#define GYPSY_CONTROL_DBUS_PATH "/org/freedesktop/Gypsy"
</pre>
<p>
A define containing the object path of the Gypsy object</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581938"></a><h3>
<a name="GYPSY-CONTROL-DBUS-INTERFACE:CAPS"></a>GYPSY_CONTROL_DBUS_INTERFACE</h3>
<a class="indexterm" name="id2587396"></a><pre class="programlisting">#define GYPSY_CONTROL_DBUS_INTERFACE "org.freedesktop.Gypsy.Server"
</pre>
<p>
A define containing the name of the Control interface</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2587417"></a><h3>
<a name="gypsy-control-get-default"></a>gypsy_control_get_default ()</h3>
<a class="indexterm" name="id2587429"></a><pre class="programlisting"><a href="GypsyControl.html" title="GypsyControl">GypsyControl</a>* gypsy_control_get_default (void);</pre>
<p>
Retrieves the default <a href="GypsyControl.html" title="GypsyControl"><span class="type">GypsyControl</span></a> object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A singleton <a href="GypsyControl.html" title="GypsyControl"><span class="type">GypsyControl</span></a>. Once the program has finished using
the <a href="GypsyControl.html" title="GypsyControl"><span class="type">GypsyControl</span></a>, it should be unreferenced with <code class="function">g_object_unref()</code>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2587501"></a><h3>
<a name="gypsy-control-create"></a>gypsy_control_create ()</h3>
<a class="indexterm" name="id2587512"></a><pre class="programlisting">char* gypsy_control_create (<a href="GypsyControl.html" title="GypsyControl">GypsyControl</a> *control,
const char *device_name,
GError **error);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>control</code></em> :</span></td>
<td> The <a href="GypsyControl.html" title="GypsyControl"><span class="type">GypsyControl</span></a> device
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>device_name</code></em> :</span></td>
<td> The path to the device file, or Bluetooth address
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A <span class="type">GError</span> to return errors in, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The path to the created object.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
