summaryrefslogtreecommitdiff
path: root/doc/explan_dgnss.c.xml
blob: a0543485e1a3d65e75736c5a01fb67a55956932b (plain)
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
<sect1 id="dgnss.c"><title><filename>dgnss.c</filename></title>
<informaltable frame='all' pgwide='1'>
<tgroup cols='2'>
<colspec colname='c1'></colspec>
<colspec colname='c2'></colspec>
<spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>

<thead>
<row>
  <entry>Functions:-</entry><entry>This file provides the interface to Differential GNSS (Global Navigation Satellite Systems) services.</entry>
</row>
</thead>

<tbody>
<row>
  <entry><function>bool dgnss_url(char *name)</function></entry>
  <entry><para>Check if a URL is valid for DGPS service.</para></entry>
</row>
<row>
  <entry><function>int dgnss_open(struct gps_context_t *context, char *dgnss_service)</function></entry>
  <entry><para>Try to open a connection to the nominated service. If the service cannot be opened, the return is -1. The supported services are <emphasis>dgpsip</emphasis> (differential corrections via IP) and <emphasis>ntrip</emphasis> (differential corrections in http form).</para></entry>
</row>
<row>
  <entry><function>int dgnss_poll(struct gps_context_t *context)</function></entry>
  <entry><para>Try to poll the DGNSS service for a correction report. If no socket is active, simply return 0. If a socket is active, on successful read it stores the current timestamp and the report in the context buffer then returns 0. If no data is ready or an error (except <errortype>EAGAIN</errortype>) occurs, drop the connection and return -1.</para></entry>
</row>
<row>
  <entry><function>void dgnss_report(struct gps_device_t *session)</function></entry>
  <entry><para>Call the <function>dgpsip_report()</function> or <function>ntrip_report()</function> function if either is active.</para></entry>
</row>
<row>
  <entry><function>void dgnss_autoconnect(struct gps_context_t *context, double lat, double lon)</function></entry>
  <entry><para>Call the <function>autoconnect()</function> function in <function>dgpsip.c</function></para></entry>
</row>
<row>
  <entry><function>void rtcm_relay(struct gps_device_t *session)</function></entry>
  <entry><para>If there is a DGNSS connection report in the context buffer, pass it to the caller. If the transaction fails, generate an error log, otherwise, update the session timestamp.</para></entry>
</row>
</tbody>

<tfoot>
<row>
  <entry spanname='s1' align='left'>Notes based on <function>$Id: dgnss.c 3771 2006-11-02 05:15:20Z esr $</function></entry>
</row>
</tfoot>

</tgroup>
</informaltable>
</sect1>