Changeset 580 for trunk/zoo-project/zoo-kernel/service_internal_java.c

Timestamp:

Feb 12, 2015, 11:18:07 PM (9 years ago)

Author:

djay

Message:

Continue adding initial doxygen documentation.

File:

• trunk/zoo-project/zoo-kernel/service_internal_java.c (modified) (7 diffs)

trunk/zoo-project/zoo-kernel/service_internal_java.c

@@ -1 @@
-/**
+/*
  * Author : Gérald FENOY
  *
@@ -25 +25 @@
 #include "service_internal_java.h"
 
+/**
+ * Load a JAVA class then run the static public method corresponding to the 
+ * service by passing the conf, inputs and outputs parameters by reference.
+ *
+ * @param main_conf the conf maps containing the main.cfg settings
+ * @param request the map containing the HTTP request
+ * @param s the service structure
+ * @param real_inputs the maps containing the inputs
+ * @param real_outputs the maps containing the outputs
+ */
 int zoo_java_support(maps** main_conf,map* request,service* s,maps **real_inputs,maps **real_outputs){
   maps* m=*main_conf;
@@ -249 +259 @@
 /**
  * Error handling: display stack trace in an ExceptionReport Document
+ *
+ * @param env the JNI environment pointer
+ * @param main_conf the conf maps containing the main.cfg settings
  */
 void displayStack(JNIEnv *env,maps* main_conf){
@@ -287 +300 @@
 }
 
+/**
+ * Create a string containing the JVM -XX:* option for a given map
+ * Depending on the map' name:
+ *  - in case the value is minus then the reult will be : -XX:-name
+ *  - in case the value is plus then the reult will be : -XX:+name
+ *  - in other cases the reult will be : -XX:name=value
+ *
+ * @param m the map containing the option
+ * @return a char* containing the valide JVM option (-XX:*)
+ */
 char *parseJVMXXOption(map* m){
   char *res=(char*)malloc((strlen(m->name)+strlen(m->value)+5)*sizeof(char));
@@ -298 +321 @@
 }
 
+/**
+ * Create a string containing the JVM -X*:* option for a given map.
+ * The reult will be in the following format: -Xname:value
+ *
+ * @param m the map containing the option
+ * @return a char* containing the valide JVM option (-XX:*)
+ */
 char *parseJVMXOption(map* m){
   char *res=(char*)malloc((strlen(m->name)+strlen(m->value)+5)*sizeof(char));
@@ -304 +334 @@
 }
 
+/**
+ * Convert a maps to a JAVA HashMap<String,HashMap<String,String>>
+ *
+ * @param env the JNI environment pointer
+ * @param t the maps to convert
+ * @param scHashMapClass the HashMap class
+ * @param scHashMap_class the HashMap class
+ * @param scHashMap_constructor the pointer to the hashMap constructor method
+ * @return a created JAVA HashMap containing the converted maps
+ * @warning make sure to free ressources returned by this function
+ */
 jobject HashMap_FromMaps(JNIEnv *env,maps* t,jclass scHashMapClass,jclass scHashMap_class,jmethodID scHashMap_constructor){
   jobject scObject,scObject1;
@@ -439 +480 @@
 }
 
+/**
+ * Convert a JAVA HashMap<String,HashMap<String,String>> to a maps
+ *
+ * @param env the JNI environment pointer
+ * @param t the HashMap 
+ * @param scHashMapClass the hashMap class
+ * @return a created maps containing the converted HashMap
+ * @warning make sure to free ressources returned by this function
+ */
 maps* mapsFromHashMap(JNIEnv *env,jobject t,jclass scHashMapClass){
 #ifdef DEBUG