Seth Woolley's Man Viewer

Manual for conf - man 3 conf

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

Configuration handling(3)                            Configuration handling(3)



NAME
       Configuration handling -

   Functions
       void discover_conf_load (discover_error_t *status)
       int discover_conf_name_to_bus (char *name, discover_error_t *status)
       discover_bus_map_t * discover_conf_get_full_bus_map (discover_error_t
           *status)
       discover_bus_map_t * discover_conf_get_bus_map_by_name (char *name,
           discover_error_t *status)
       discover_bus_map_t * discover_conf_get_bus_map (discover_bus_t bus,
           discover_error_t *status)
       void discover_conf_insert_url (char *url, discover_error_t *status)
       void discover_conf_append_url (char *url, discover_error_t *status)
       discover_xml_url_t * discover_conf_get_urls (discover_error_t *status)
       void discover_conf_free (void)
       char * discover_conf_get_bus_name (discover_bus_t bus)
       char * discover_conf_get_filetype_name (discover_filetype_t filetype)

Function Documentation
   void discover_conf_append_url (char * url, discover_error_t * status)
       Append the URL specified in(1,8) url at the tail of the list of URLs where
       Discover data will be retrieved.

       Parameters:
           url URL to append
           status Address in(1,8) which to place status report



       Definition at line 566 of file(1,n) conf.c.

       References discover_error::code, discover_conf_load(), and
       discover_error_t.

   void discover_conf_free (void)
       Free configuration data. This is mainly useful so that the next call to
       discover_conf_load will reload the configuration data.

       Definition at line 637 of file(1,n) conf.c.

       References discover_xml_url_free().

   discover_bus_map_t* discover_conf_get_bus_map (discover_bus_t bus,
       discover_error_t * status)
       Get the bus map for a single bus.

       Parameters:
           bus Name of the bus whose map to get
           status Address in(1,8) which to place status report



       Definition at line 519 of file(1,n) conf.c.

       References discover_error::code, discover_bus_map_t,
       discover_conf_load(), and discover_error_t.

       Referenced by discover_get_devices().

   discover_bus_map_t* discover_conf_get_bus_map_by_name (char * name,
       discover_error_t * status)
       Get the bus map by name for a single bus.

       Parameters:
           name Name of the bus whose map to get
           status Address in(1,8) which to place status report



       Definition at line 496 of file(1,n) conf.c.

       References _real_discover_conf_get_bus_map_by_name(),
       discover_error::code, discover_conf_load(), and discover_error_t.

   char* discover_conf_get_bus_name (discover_bus_t bus)
       Translate an enum bus value into a string.

       Parameters:
           bus Bus type in(1,8) enumerated form



       Definition at line 653 of file(1,n) conf.c.

       References discover_bus_map::name.

       Referenced by discover_xml_get_data_urls().

   char* discover_conf_get_filetype_name (discover_filetype_t filetype)
       Translate an enum filetype value into a string.

       Parameters:
           filetype Filetype in(1,8) enumerated form



       Definition at line 669 of file(1,n) conf.c.

       Referenced by discover_xml_get_data_urls().

   discover_bus_map_t* discover_conf_get_full_bus_map (discover_error_t *
       status)
       Get the full bus map, listing all buses.

       Parameters:
           status Address in(1,8) which to place status report



       Definition at line 483 of file(1,n) conf.c.

       References discover_conf_load(), and discover_error_t.

       Referenced by discover_device_find().

   discover_xml_url_t* discover_conf_get_urls (discover_error_t * status)
       Get the list of URLs from which XML data will be retrieved.

       Parameters:
           status Address in(1,8) which to place status report



       Definition at line 586 of file(1,n) conf.c.

       References discover_error::code, discover_conf_load(),
       discover_error_t, discover_xml_url_new(), and discover_xml_url_t.

       Referenced by discover_xml_get_urls().

   void discover_conf_insert_url (char * url, discover_error_t * status)
       Insert the URL specified in(1,8) url at the head of the list of URLs where
       Discover data will be retrieved.

       Parameters:
           url URL to insert
           status Address in(1,8) which to place status report



       Definition at line 544 of file(1,n) conf.c.

       References discover_error::code, discover_conf_load(), and
       discover_error_t.

   void discover_conf_load (discover_error_t * status)
       Ensure that the configuration file(1,n) is loaded. Repeated calls to this
       function will not change anything, unless you call discover_conf_free.

       Technically, this function will lie to you if(3,n) there is no conf(3,5) file.
       Even though no configuration was loaded, repeated calls still will not
       change anything. However, if(3,n) we don't do this and a config(1,5) file(1,n) is
       created between the time(1,2,n) some long-lived caller first calls
       discover_conf_load and the time(1,2,n) it calls it again, it will be loaded.
       This doesn't strike me as idempotent behavior. So, repeated calls even
       in(1,8) this case will not change anything unless you call
       discover_conf_free.

       Parameters:
           status Address in(1,8) which to place status report



       Definition at line 378 of file(1,n) conf.c.

       References discover_error::code, discover_error::create_message, and
       discover_error_t.

       Referenced by discover_conf_append_url(), discover_conf_get_bus_map(),
       discover_conf_get_bus_map_by_name(), discover_conf_get_full_bus_map(),
       discover_conf_get_urls(), and discover_conf_insert_url().

   int discover_conf_name_to_bus (char * name, discover_error_t * status)
       Get the bus enumeration for a bus name.

       Parameters:
           name Name of the bus
           status Address in(1,8) which to place status report



       Definition at line 464 of file(1,n) conf.c.

       References discover_error::code, discover_error_t, and
       discover_bus_map::name.

       Referenced by _real_discover_conf_get_bus_map_by_name().



discover(1,3,5)                          19 Nov 2004        Configuration handling(3)

References for this manual (incoming links)