diff options
author | William R. Otte <wotte@dre.vanderbilt.edu> | 2009-08-16 20:41:22 +0000 |
---|---|---|
committer | William R. Otte <wotte@dre.vanderbilt.edu> | 2009-08-16 20:41:22 +0000 |
commit | 3b37923a14c7db4d9d602cd9166be38f6104da50 (patch) | |
tree | 63477c4878be44047f054092ab3a9b8bb77ba59f /modules/CIAO/docs/ConfigValues.html | |
parent | 767b53703f187eddaf51b3a1d99c6984bf8ba75f (diff) | |
download | ATCD-3b37923a14c7db4d9d602cd9166be38f6104da50.tar.gz |
branching/tagging
Diffstat (limited to 'modules/CIAO/docs/ConfigValues.html')
-rw-r--r-- | modules/CIAO/docs/ConfigValues.html | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/modules/CIAO/docs/ConfigValues.html b/modules/CIAO/docs/ConfigValues.html new file mode 100644 index 00000000000..70ade5ca68d --- /dev/null +++ b/modules/CIAO/docs/ConfigValues.html @@ -0,0 +1,270 @@ +<!-- $Id$ --> +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> +<html> <head> +<title>ConfigValues Index</title> +</head> + +<body> + +<h1>Index of ConfigValues</h1> + +<font size="+1" color="red">This page is currently a placeholder for +all the configuration values we will support when creating various CCM +deployment mechanisms, such as ComponentServers and Containers. The +ConfigValues listed here are currently only partially supported in +CIAO. <p> + +Note from self: There are discrepancy in this document. Most +significantly, (RT)ComponentServer's don't get their ConfigValues +directly from that passed in thru +ServerActivator::create_component_server but rather, using some sort +of pre-defined command line flags. +</font> + +<h2>ComponentServer</h2> +The <code>ConfigValues</code> for a <code>ComponentServer</code> are +passed in via <code>ServerActivator::create_component_server</code> +operation. CIAO accepts the following feature names:<p> + +<table border="3" spacing="2" cellpadding="3"> + <tr> + <th>FeatureName</th> + <th>type</th> + <th>Requirement</th> + <th>Remarks</th> + </tr> + <tr> + <td>CIAO-svcconf-id</td> + <td>string</td> + <td> + Optional + </td> + <td> + Specify the canonical svc.conf id. This id should only serve + as a hint for the deployment framework in determining the + actual svc.conf file used to start up the component server. + Currently, CIAO's ServerActivator maintains a set of svc.conf + files and use this id value to map to the exact svc.conf file + name. + </td> + </tr> + <tr> + <td>CIAO-ORB[option]</td> + <td>string</td> + <td> + Optional + </td> + <td> + Specify an ORB option that you want to pass to the + ComponentServer ORB. + </td> + </tr> +</table> + +<h2>RTComponentServer (Real-time ComponentServer)</h2> + +Like a regular <code>ComponentServer</code>, the +<code>ConfigValues</code> for a <code>RTComponentServer</code> are +passed in via <code>ServerActivator::create_component_server</code> +operation. On top of the <code>ConfigValues</code> accepted by the +regular <code>ComponentServer</code>, a real-time ComponentServer also +accepts the following feature names:<p> + +<table border="3" spacing="2" cellpadding="3"> + <tr> + <th>FeatureName</th> + <th>type</th> + <th>Requirement</th> + <th>Remarks</th> + </tr> + <tr> + <td>CIAO-rtcad-filename</td> + <td>string</td> + <td> + Optional + </td> + <td> + Specify the filename of RTCAD extension XML file. + The component server will invoke the XML parser and translate + the content of the file into the following two ConfigValues + (CIAO-RTresources and CIAO-RTPolicySets) to + RTComponentServer implementation. + </td> + </tr> + <tr> + <td>CIAO-RTresources</td> + <td><code>CIAO::RTConfiguration::RTORB_Resources_Info</code></td> + <td> + Optional + </td> + <td> + <code>CIAO::RTConfiguration::RTORB_Resources_Info</code> as + defined in + <code>$CIAO_ROOT/tools/XML_Helpers/RTConfiguration.idl</code> + defines the system wise resources an RT ORB should allocate. + These resources then can be used to define the RT policies in + the RTPolicySet described subsequently. + </td> + </tr> + <tr> + <td>CIAO-RTPolicySets</td> + <td><code>CIAO::RTConfiguration::Policy_Sets</code></td> + <td> + Optional + </td> + <td> + <code>CIAO::RTConfiguration::Policy_Sets</code>, also + defined in + <code>$CIAO_ROOT/tools/XML_Helpers/RTConfiguration.idl</code>, + defines a list of policy sets, which are named sequences of + policies. These policies often refer to the global resources + defined in the previous CIAO-RTresource via names. Likewise, + an <b>RT-container</b> also specifies the RTPolicySet its POA + uses via the name defined here. + </td> + </tr> +</table> + +<h2>Container</h2> +The <code>ConfigValues</code> for a <code>Container</code> are +passed in via <code>ComponentServer::create_container</code> +operation. CIAO accepts the following feature names:<p> + +<table border="3" spacing="2" cellpadding="3"> + <tr> + <th>FeatureName</th> + <th>type</th> + <th>Requirement</th> + <th>Remarks</th> + </tr> + <tr> + <td> + CIAO-Container-Type + </td> + <td> + <code>string</code> + </td> + <td> + currently not supported. + </td> + <td> + Possible value: <code>session</code>, <code>rt-session</code>, + <code>unclassified</code>, <code>rt-unclassified</code>. + </td> + </tr> + + <tr> + <td> + CIAO-POAPolicies + </td> + <td> + <code>CORBA::PolicyList</code> + </td> + <td> + Currently not supported. + </td> + <td> + Must not conflict with CIAO-Container-Type setting. + (Certain containers assume several POA policies.) + </td> + </tr> + + <tr> + <td> + CIAO-RTPolicySet + </td> + <td> + <code>string</code> + </td> + <td> + Optional + </td> + <td> + Name, as defined in RTCompoenentServer's CIAO-RTPolicySets, of + the PolicySet this container uses. + </td> + </tr> +</table> + + +<h2>CCMHome</h2> +The <code>ConfigValues</code> for a <code>CCMHome</code> are +passed in via <code>Container::install_home</code> +operation. CIAO accepts the following feature names:<p> + +<table border="3" spacing="2" cellpadding="3"> + <tr> + <th>FeatureName</th> + <th>type</th> + <th>Requirement</th> + <th>Remarks</th> + </tr> + <tr> + <td>CIAO-executor-path</td> + <td><code>string</code></td> + <td> + REQUIRED + </td> + <td> + This string value specifies the location of the executor DLL. + In the future, we should use UUIDs to identify the component + executors and query the ComponentInstallation interface for + the actual location of the DLL. + </td> + </tr> + <tr> + <td>CIAO-executor-entrypt</td> + <td><code>string</code></td> + <td> + REQUIRED + </td> + <td> + This string value specifies the entry point of the executor + DLL. It points to a factory function for the component executor. + </td> + </tr> + <tr> + <td>CIAO-servant-path</td> + <td><code>string</code></td> + <td> + REQUIRED + </td> + <td> + This string value specifies the location of the servant DLL. + In the future, we should use UUIDs to identify the component + servants and query the ComponentInstallation interface for + the actual location of the DLL. <p> + + Servant are part of the Container framework and we can use + type checking to ensure servant and container match with each + other. + </td> + </tr> + <tr> + <td>CIAO-executor-entrypt</td> + <td><code>string</code></td> + <td> + REQUIRED + </td> + <td> + This string value specifies the entry point of the servant + DLL. It points to a factory function for the compnent servant. + </td> + </tr> +</table> + +<!-- + <tr> + <td> + a + </td> + <td> + b + </td> + <td> + c + </td> + </tr> +--> +<!--#include virtual="/~nanbor/signature.html" --> +</body> </html> |