Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

45 lines
2.1 KiB

  1. <sect1 id="gpsd.h"><title><filename>gpsd.h</filename></title>
  2. <informaltable frame='all' pgwide='1'>
  3. <tgroup cols='2'>
  4. <colspec colname='c1'></colspec>
  5. <colspec colname='c2'></colspec>
  6. <spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>
  7. <thead>
  8. <row>
  9. <entry>Structures:-</entry><entry>Provides fundamental types and structures for the GPS daemon. Only key structures are analysed here. Simple definitions and prototype definitions are ignored.</entry>
  10. </row>
  11. </thead>
  12. <tfoot>
  13. <row>
  14. <entry spanname='s1' align='left'>Notes based on code as of Mon Apr 5 21:38:06 2010 -0400</entry>
  15. </row>
  16. </tfoot>
  17. <tbody>
  18. <row>
  19. <entry spanname='s1' align='left'><para>This file is created at <function>configure</function> time by combining <function>gpsd.h-head</function>, certain configuration options from the auto-generated file <function>gpsd_configure.h</function> and <function>gpsd.h-tail</function>. This file (<function>gpsd.h</function>) should not be edited directly, neither should <function>gpsd.h-head</function>. You should only edit <function>gpsd.h-tail</function> as needed.</para></entry>
  20. </row>
  21. <row>
  22. <entry><function>struct gps_packet_t {}</function></entry>
  23. <entry><para>Provides the data structure used by <function>packet_getter()</function>. 1 per <application>gpsd</application> session.</para></entry>
  24. </row>
  25. <row>
  26. <entry><function>struct gps_context_t {}</function></entry>
  27. <entry><para>Provides context data like number of good fixes seen. 1 per <application>gpsd</application> session.</para></entry>
  28. </row>
  29. <row>
  30. <entry><function>struct gps_type_t {}</function></entry>
  31. <entry><para>This is the method table that every driver uses to communicate with the daemon. It is a table of entry points or externally visible data. 1 per driver type.</para></entry>
  32. </row>
  33. <row>
  34. <entry><function>struct gps_device_t {}</function></entry>
  35. <entry><para>This is the data belonging to a session (global state) and also private storage for the session's associated device driver (if needed). 1 per <application>gpsd</application> session.</para></entry>
  36. </row>
  37. </tbody>
  38. </tgroup>
  39. </informaltable>
  40. </sect1>