Changes between Version 10 and Version 11 of documentation/tools/monitoring/rest

Timestamp:

02/18/12 16:50:27 (12 years ago)

Author:

zagaria

Comment:

--

documentation/tools/monitoring/rest

@@ -41 +41 @@
 
 <method>
-hello_client
+  /hello_client
 <\method>
 <hello>
@@ -59 +59 @@
 
 }}}
+
+== Example method ==
+
+This example will show you how to create a method for the rest interface.
+For this example we add the ''hello_client'' method to the collectors interface.
+The function_wrapper.hpp and function_wrapper.cpp are where the method has to be defined and implemented.
+
+We add {{{std::string hello_client(std::vector<std::strings>);}}} to the header file and implement the method.
+Note that all arguments are saved into a vector of string, the responsebility of converting the arguments into the right data type is part of the method as well as the creation if the XML document for the reply.
+
+
+{{{
+
+std::string function_wrapper::hello_client(std::vector<std::string> args){
+    if(args.size() > 1){
+        return std::string();
+    }
+    else{
+        std::stringstream output;
+        boost::property_tree::ptree pt;
+        pt.add("method","/hello_client");
+        try{
+           int end  = boost::lexical_cast<int>(args.first());
+           for(int i = 1 ; i <= end; i++){
+             pt.add("count.num",i);
+            }
+        }  
+        catch(exception &e){
+          std::cout << e.what() << std::endl;
+          return std::string();
+        }
+        try{
+            boost::property_tree::xml_parser::xml_writer_settings<char> w(' ', 2);
+            boost::property_tree::xml_parser::write_xml( output, pt,w );
+        }
+        catch (std::exception& e){
+            std::cout << e.what() << std::endl;
+            return std::string();
+        }
+        return output.str();
+    }
+}
+}}}
+
+
+
+
+
+