Add Camera Module

[apps/native/position-finder-server.git] / inc / connectivity.h

diff --git a/inc/connectivity.h b/inc/connectivity.h
index 5165dda..f35ed6c 100644 (file)
--- a/inc/connectivity.h
+++ b/inc/connectivity.h
@@ -22,18 +22,26 @@
 #ifndef __POSITION_FINDER_CONNECTIVITY_H__
 #define __POSITION_FINDER_CONNECTIVITY_H__
 
-#include "connectivity_internal.h"
+typedef struct _connectivity_resource connectivity_resource_s;
 
-struct connectivity_resource {
-       iotcon_resource_h res;
-       iotcon_observers_h observers;
-       char *path;
-};
+typedef enum {
+       CONNECTIVITY_PROTOCOL_DEFAULT = 0, /* default protocol */
+       CONNECTIVITY_PROTOCOL_IOTIVITY, /* IoTvity protocol */
+       CONNECTIVITY_PROTOCOL_HTTP, /* HTTP protocol */
+       CONNECTIVITY_PROTOCOL_MAX
+} connectivity_protocol_e;
 
-typedef struct connectivity_resource connectivity_resource_s;
+/**
+ * @brief Set connectivity protocol to communicate with other devices.
+ * @param[in] protocol_type protocol type to use
+ * @return 0 on success, otherwise a negative error value
+ * @see You should set protocol before call connectivity_set_resource(),
+ * otherwise IoTvitiy protocol will be set as default.
+ */
+extern int connectivity_set_protocol(connectivity_protocol_e protocol_type);
 
 /**
- * @brief Create connectivity resource and registers the resource in server.
+ * @brief Create connectivity resource.
  * @param[in] path The path of the resource
  * @param[in] type The string data to insert into the resource types (e.g. "org.tizen.light")
  * @param[out] out_resource_info A structure containing information about connectivity resource
@@ -50,7 +58,7 @@ extern int connectivity_set_resource(const char *path, const char *type, connect
 extern void connectivity_unset_resource(connectivity_resource_s *resource);
 
 /**
- * @brief Notifies a resource's value to observed clients.
+ * @brief Notifies a resource's value to observed devices or clouds.
  * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A key to be sended.
  * @param[in] value A value to be sended.
@@ -60,7 +68,7 @@ extern void connectivity_unset_resource(connectivity_resource_s *resource);
 extern int connectivity_notify_bool(connectivity_resource_s *resource_info, const char *key, bool value);
 
 /**
- * @brief Notifies a resource's value to observed clients.
+ * @brief Notifies a resource's value to observed devices or clouds.
  * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A key to be sended.
  * @param[in] value A value to be sended.
@@ -70,7 +78,7 @@ extern int connectivity_notify_bool(connectivity_resource_s *resource_info, cons
 extern int connectivity_notify_int(connectivity_resource_s *resource_info, const char *key, int value);
 
 /**
- * @brief Notifies a resource's value to observed clients.
+ * @brief Notifies a resource's value to observed devices or clouds.
  * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A key to be sended.
  * @param[in] value A value to be sended.
@@ -80,13 +88,77 @@ extern int connectivity_notify_int(connectivity_resource_s *resource_info, const
 extern int connectivity_notify_double(connectivity_resource_s *resource_info, const char *key, double value);
 
 /**
- * @brief Notifies a resource's value to observed clients.
+ * @brief Notifies a resource's value to observed devices or clouds.
  * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A key to be sended.
  * @param[in] value A value to be sended.
  * @return 0 on success, otherwise a negative error value
  * @see If key is already exists, current value will be replaced with new value.
  */
-extern int connectivity_notify_string(connectivity_resource_s *resource_info, const char *key, char *value);
+extern int connectivity_notify_string(connectivity_resource_s *resource_info, const char *key, const char *value);
+
+/* TODO : add comments for these functions */
+/**
+ * @brief Add a boolean type value to attributes for notifying to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @param[in] key A key to be sended.
+ * @param[in] value A value to be added.
+ * @return 0 on success, otherwise a negative error value
+ * @see If key is already exists, current value will be replaced with new value.
+ */
+extern int connectivity_attributes_add_bool(connectivity_resource_s *resource_info, const char *key, bool value);
+
+/**
+ * @brief Add a integer type value to attributes for notifying to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @param[in] key A key to be sended.
+ * @param[in] value A value to be added.
+ * @return 0 on success, otherwise a negative error value
+ * @see If key is already exists, current value will be replaced with new value.
+ */
+extern int connectivity_attributes_add_int(connectivity_resource_s *resource_info, const char *key, int value);
+
+/**
+ * @brief Add a double type value to attributes for notifying to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @param[in] key A key to be sended.
+ * @param[in] value A value to be added.
+ * @return 0 on success, otherwise a negative error value
+ * @see If key is already exists, current value will be replaced with new value.
+ */
+extern int connectivity_attributes_add_double(connectivity_resource_s *resource_info, const char *key, double value);
+
+/**
+ * @brief Add a string value to attributes for notifying to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @param[in] key A key to be sended.
+ * @param[in] value A value to be added.
+ * @return 0 on success, otherwise a negative error value
+ * @see If key is already exists, current value will be replaced with new value.
+ */
+extern int connectivity_attributes_add_string(connectivity_resource_s *resource_info, const char *key, const char *value);
+
+/**
+ * @brief Notifies values in the attributs to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @return 0 on success, otherwise a negative error value
+ */
+extern int connectivity_attributes_notify_all(connectivity_resource_s *resource_info);
+
+/**
+ * @brief Remove a value from attributes for notifying to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @param[in] key A key to be sended.
+ * @return 0 on success, otherwise a negative error value
+ * @see If key is already exists, current value will be replaced with new value.
+ */
+extern int connectivity_attributes_remove_value_by_key(connectivity_resource_s *resource_info, const char *key);
+
+/**
+ * @brief Remove all values from attributes for notifying to observed devices or clouds.
+ * @param[in] resource_info A structure containing information about connectivity resource
+ * @return 0 on success, otherwise a negative error value
+ */
+extern int connectivity_attributes_remove_all(connectivity_resource_s *resource_info);
 
 #endif /* __POSITION_FINDER_CONNECTIVITY_H__ */