Merge remote-tracking branch 'origin/routing-manager'

[platform/upstream/iotivity.git] / resource / csdk / stack / include / internal / ocresourcehandler.h

diff --git a/resource/csdk/stack/include/internal/ocresourcehandler.h b/resource/csdk/stack/include/internal/ocresourcehandler.h
index c0744c1..606350f 100644 (file)
--- a/resource/csdk/stack/include/internal/ocresourcehandler.h
+++ b/resource/csdk/stack/include/internal/ocresourcehandler.h
@@ -36,6 +36,7 @@
 #define OC_JSON_SUFFIX_LEN                 (sizeof(OC_JSON_SUFFIX) - 1)
 #define OC_JSON_SEPARATOR                  ','
 #define OC_JSON_SEPARATOR_STR              ","
+#define OC_KEY_VALUE_DELIMITER             "="
 
 /**
  * Static values for various JSON attributes.
@@ -44,6 +45,38 @@
 #define OC_RESOURCE_SECURE       1
 
 /**
+ *  OIC Virtual resources supported by every OIC device.
+ */
+typedef enum
+{
+    /** unknown URI.*/
+    OC_UNKNOWN_URI =0,
+
+    /** "/oic/res".*/
+    OC_WELL_KNOWN_URI,
+
+    /** "/oic/d" .*/
+    OC_DEVICE_URI,
+
+    /** "/oic/p" .*/
+    OC_PLATFORM_URI,
+
+    /** "/oic/res/d/type" .*/
+    OC_RESOURCE_TYPES_URI,
+#ifdef ROUTING_GATEWAY
+    /** "/oic/gateway" .*/
+    OC_GATEWAY_URI,
+#endif
+    #ifdef WITH_PRESENCE
+    /** "/oic/ad" .*/
+    OC_PRESENCE,
+    #endif
+
+    /** Max items in the list */
+    OC_MAX_VIRTUAL_RESOURCES    //<s Max items in the list
+} OCVirtualResources;
+
+/**
  * The type of query a request/response message is.
  */
 typedef enum
@@ -74,28 +107,26 @@ typedef enum
  * no entity handler.
  */
 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
-        OCEntityHandlerRequest * request);
-
-/**
- * Get string value associated with a virtual resource type.
- */
-const char * GetVirtualResourceUri(OCVirtualResources resource);
+        OCEntityHandlerRequest * request, void* callbackParam);
 
 /**
  * Find and retrieve pointer to a resource associated with a specific resource
  * URI.
+ * @return pointer to found resource
  */
 OCResource *FindResourceByUri(const char* resourceUri);
 
 /**
- * Returns true if the specificed resource URI aligns with a pre-existing
+ * This function checks whether the specified resource URI aligns with a pre-existing
  * virtual resource; returns false otherwise.
+ * @return true or false.
  */
 bool IsVirtualResource(const char* resourceUri);
 
 /**
  * Parameter @ref handling returns by-reference the type of resource handling
  * required by the internal stack based on the specified @ref request.
+ * @return ::OC_STACK_OK for Success, otherwise some error value
  */
 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
                                          ResourceHandling *handling,
@@ -104,6 +135,7 @@ OCStackResult DetermineResourceHandling (const OCServerRequest *request,
 /**
  * Processes the specified @ref request based on the type of resource handling
  * @ref resHandling.
+ * @return ::OC_STACK_OK for Success, otherwise some error value.
  */
 OCStackResult ProcessRequest(ResourceHandling resHandling,
                              OCResource *resource,
@@ -112,10 +144,20 @@ OCStackResult ProcessRequest(ResourceHandling resHandling,
 /**
  * Internal API used to save all of the platform's information for use in platform
  * discovery requests.
+ * @return ::OC_STACK_OK for Success, otherwise some error value.
  */
 OCStackResult SavePlatformInfo(OCPlatformInfo info);
 
 /**
+ * Internal API used to save all of the device's information for use in platform
+ * discovery requests.
+ * @param info       Device name is received from the application.
+ *                   DeviceID, spec version and data model version are initialized by the stack.
+ * @return ::OC_STACK_OK for Success, otherwise some error value.
+ */
+OCStackResult SaveDeviceInfo(OCDeviceInfo info);
+
+/**
  * Internal API used to clear the platform information.
  */
 void DeletePlatformInfo();
@@ -125,15 +167,18 @@ void DeletePlatformInfo();
  */
 void DeleteDeviceInfo();
 
+/*
+ * Prepare payload for resource representation.
+ */
+OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
+                    OCRepPayload** payload);
+
 /**
- * Prepares a JSON string for response.
+ * Prepares a Payload for response.
  */
 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
-                                           uint8_t filterOn,
-                                           const char *filterValue,
-                                           char * out,
-                                           uint16_t *remaining,
-                                           CATransportType_t connType);
+                                           OCDiscoveryPayload* payload,
+                                           OCDevAddr *endpoint);
 
 /**
  * A helper function that Maps an @ref OCEntityHandlerResult type to an