1. Moved the declaration of the osrf_host_config struct out of the header.
[OpenSRF.git] / include / opensrf / osrf_settings.h
index d0e23df..fe4d399 100644 (file)
 
 #include <opensrf/osrf_json.h>
 
-typedef struct { 
-       char* hostname; 
-       jsonObject* config; 
-} osrf_host_config;
+/**
+       @file osrf_settings.h
+       @brief Facility for retrieving server configuration settings.
 
+       Look up server configuration settings from a settings server, cache them in the form of
+       a jsonObject, and retrieve them on request.
+
+       Not generally intended for client processes, unless they are also servers in their own right.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct osrf_host_config_;
+typedef struct osrf_host_config_ osrf_host_config;
 
-osrf_host_config* osrf_settings_new_host_config(char* hostname);
 void osrf_settings_free_host_config(osrf_host_config*);
-char* osrf_settings_host_value(char* path, ...);
-jsonObject* osrf_settings_host_value_object(char* format, ...);
-int osrf_settings_retrieve(char* hostname);
+char* osrf_settings_host_value(const char* path, ...);
+jsonObject* osrf_settings_host_value_object(const char* format, ...);
+int osrf_settings_retrieve(const char* hostname);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif