Changeset 10477 for trunk/FACT++

Timestamp:

04/28/11 11:08:19 (13 years ago)

Author:

tbretz

Message:

Added descriptions for the service itself and for the default Dim services.

File:

• trunk/FACT++/src/DimDescriptionService.cc (modified) (3 diffs)

trunk/FACT++/src/DimDescriptionService.cc

@@ -68 +68 @@
 DimDescriptionService::DimDescriptionService(const std::string &name, const std::string &desc)
 {
-    string service = DimServer::itsName;
-    if (service.empty())
+    string server = DimServer::itsName;
+    if (server.empty())
     {
         const size_t p = name.find_first_of('/');
@@ -75 +75 @@
             throw logic_error("Could not determine server name");
 
-        service = name.substr(0, p);
+        server = name.substr(0, p);
     }
 
@@ -81 +81 @@
             throw logic_error("Description for "+name+" contains '\\n'");
 
-    service += "/SERVICE_DESC";
     if (!fService)
-        fService = new DimService(service.c_str(), const_cast<char*>(""));
+    {
+        fService = new DimService((server+"/SERVICE_DESC").c_str(), const_cast<char*>(""));
+        fData =
+            server + "/SERVICE_DESC"
+            "=This service holds a descriptions for services or command "
+            "and there arguments|Description[string]:For a detailed "
+            "explanation of the descriptive string see the class reference "
+            "of DimDescriptionService.\n" +
+            server + "/CLIENT_LIST"
+            "=This is a native Dim service. It contains a list "
+            "of all clients currently connected.\n" +
+            server + "/VERSION_NUMBER"
+            "=This is a native Dim service. It contains the version number "
+            "of Dim in use and can be used to check if a client is connected."
+            "|DimVer[int]:Version*100+Release (e.g. V19r17 = 1917)\n" +
+            server + "/EXIT"
+            "=This is a native Dim service. It allows to exit the program "
+            "remotely. FACT++ programs use the given number as return code."
+            "|Rc[int]:Return code (42 will call exit() directly, 0x4242 will call abort() directly.\n" +
+            server + "/SERVICE_LIST"
+            "=This is a native Dim service. It provides a list of all "
+            "commands and services together with their formats currently "
+            "provided by the server."
+            "|ServiceList[string]:For details see the Dim manual.\n";
+    }
+
 
     fCount++;