diff options
| author | dengg <dengg@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> | 2005-08-09 13:00:46 +0000 |
|---|---|---|
| committer | dengg <dengg@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> | 2005-08-09 13:00:46 +0000 |
| commit | ac0c1fcc8c7c287210c37e655a78af0c5373f198 (patch) | |
| tree | e109f98b1b22bc102a54d2eb98a278c320cc1313 /TAO/CIAO/docs | |
| parent | 98c553c9fae6917890ef9207b1d1c455dcd73bea (diff) | |
| download | ATCD-ac0c1fcc8c7c287210c37e655a78af0c5373f198.tar.gz | |
Mon Aug 08 22:02:43 2005 Gan Deng <dengg@dre.vanderbilt.edu>
Diffstat (limited to 'TAO/CIAO/docs')
| -rw-r--r-- | TAO/CIAO/docs/EnvVars.html | 50 | ||||
| -rw-r--r-- | TAO/CIAO/docs/Trace.html | 32 | ||||
| -rw-r--r-- | TAO/CIAO/docs/imgs/DAnCE-Dynamic.png | bin | 0 -> 71061 bytes | |||
| -rw-r--r-- | TAO/CIAO/docs/imgs/DAnCE-Dynamic.sxd | bin | 0 -> 1619 bytes | |||
| -rw-r--r-- | TAO/CIAO/docs/index.html | 220 |
5 files changed, 187 insertions, 115 deletions
diff --git a/TAO/CIAO/docs/EnvVars.html b/TAO/CIAO/docs/EnvVars.html index 13c7a260694..a088f793de0 100644 --- a/TAO/CIAO/docs/EnvVars.html +++ b/TAO/CIAO/docs/EnvVars.html @@ -1,39 +1,35 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> +<html> +<head> <!-- $Id$ --> -<html> <head> -<title>Environment Variables used by CIAO</title> + <title>Environment Variables used by CIAO</title> </head> - <body> <h1>Environment Variables used by CIAO</h1> - <ul> -<!-- <li><b><code></code></b><p> --> - <li><b><code>CIAO_DEBUG_LEVEL</code></b>: An interger value - accessible using <CODE>CIAO::debug_level()</CODE> call. - Currently, CIAO follow the following usage - conventions: - <ul> - <li> 20 < debug_level ≤ 20: Generate CIAO internal - debug messages - <li> 10 < debug_level ≤ 20: Generate CIAO tools - debug messages - <li> 0 < debug_level ≤ 10: Generate component-level - debug messages - </ul> <p> - - <li><b><code>CIAO_FIFO_SCHED</code></b>: Defining this Env. Var to 1 - will trigger ComponentServer to run in FIFO scheduling class.<p> - - <li><B><CODE>CIAO_DUMP_SAMPLE_HISTORY</CODE></B>: This environment - variable was added for lack of component configuration support. - Set it to 1 to turn on the dumping of performance samples to - stdout in some performance test components.<p> +<!-- <li><b><code></code></b><p> --> <li><b><code>CIAO_DEBUG_LEVEL</code></b>: +An interger value accessible using <code>CIAO::debug_level()</code> +call. Currently, CIAO follow the following usage conventions:<br> + <br> + <ul> + <li> 20 < debug_level ≤ 20: Generate CIAO internal debug +messages </li> + <li> 10 < debug_level ≤ 20: Generate CIAO tools debug messages + </li> + <li> 0 < debug_level ≤ 10: Generate component-level debug +messages </li> + </ul> + <p> </p> + </li> + <li><b><code>CIAO_DUMP_SAMPLE_HISTORY</code></b>: This environment +variable was added for lack of component configuration support. Set it +to 1 to turn on the dumping of performance samples to stdout in some +performance test components.</li> </ul> - <hr> <address>Nanbor Wang</address> <!-- hhmts start --> Last modified: Sun Nov 30 20:29:14 Mountain Standard Time 2003 <!-- hhmts end --> -</body> </html> +</body> +</html> diff --git a/TAO/CIAO/docs/Trace.html b/TAO/CIAO/docs/Trace.html new file mode 100644 index 00000000000..001cddd007e --- /dev/null +++ b/TAO/CIAO/docs/Trace.html @@ -0,0 +1,32 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> +<html> +<head> +<!-- $Id$ --> + <title>CIAO Logging facility</title> +</head> +<body> +<h1>CIAO Logging Facility +</h1> +Based on the various logging techniques provided by ACE mechanism, CIAO +has introduced some new logging macros to assist CIAO developers in +diagnosing CIAO codes.<br> +<ul> + <li><span style="font-weight: bold;">CIAO_TRACE<br> + </span> By placing CIAO_TRACE at the beginning of +a CIAO function or method, you can get the tracing message of when +these functions are entered and when they are exited at runtime. To +enable this feature, however, you need to set CIAO_NTRACE to 0 in +$ACE_ROOT\ace\config.h. CIAO_TRACE works in a identical way as +ACE_TRACE. The only distinction is that CIAO_TRACE will output the the +tracing messages for CIAO projects only while dumping the excessive +messages from ACE on top of which CIAO is built. <br> + </li> +</ul> +<hr> +<address>Ming Xiong<br> +Last modified: Thur Aug 12:50 am 2005 +</address> +<!-- hhmts start --> +<!-- hhmts end --> +</body> +</html> diff --git a/TAO/CIAO/docs/imgs/DAnCE-Dynamic.png b/TAO/CIAO/docs/imgs/DAnCE-Dynamic.png Binary files differnew file mode 100644 index 00000000000..2e9917e1520 --- /dev/null +++ b/TAO/CIAO/docs/imgs/DAnCE-Dynamic.png diff --git a/TAO/CIAO/docs/imgs/DAnCE-Dynamic.sxd b/TAO/CIAO/docs/imgs/DAnCE-Dynamic.sxd Binary files differnew file mode 100644 index 00000000000..698a445ddc2 --- /dev/null +++ b/TAO/CIAO/docs/imgs/DAnCE-Dynamic.sxd diff --git a/TAO/CIAO/docs/index.html b/TAO/CIAO/docs/index.html index 423cbdb08f5..344ee99c2d7 100644 --- a/TAO/CIAO/docs/index.html +++ b/TAO/CIAO/docs/index.html @@ -1,125 +1,169 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> +<html> +<head> <!-- $Id$ --> -<html> <head> -<title>CIAO - Component-Integrated ACE ORB</title> + <title>CIAO - Component-Integrated ACE ORB</title> </head> - <body> <h1>CIAO - Component-Integrated ACE ORB</h1> - <h2>Introduction</h2> CIAO is TAO's implementation of <a -href="http://cgi.omg.org/cgi-bin/doc?formal/02-06-65"> CORBA Component + href="http://cgi.omg.org/cgi-bin/doc?formal/02-06-65"> CORBA Component Model (CCM)</a> specially optimized for distributed real-time embedded (DRE) systems. - This page contains links to other documents and resources for building -and using CIAO. - +and using CIAO.<br> +<br> +<hr> <h2>The CIAO Project</h2> <ul> - <li>The main - <a href="http://www.cs.wustl.edu/~schmidt/CIAO.html"> - CIAO project page</a>.<p> - - <li>CIAO <A HREF="../CIAO-INSTALL.html">Installation instructions</a>.<p> - - <li>Project <a href="releasenotes/index.html">Status (aka. release - notes.)</a><p> - - <li><a href="../NEWS">What's NEW about CIAO</a> :-) <p> + <li>The main <a href="http://www.cs.wustl.edu/%7Eschmidt/CIAO.html"> +CIAO project page</a>.</li> + <li><a href="../CIAO-INSTALL.html">Installation instructions</a> for +CIAO<br> + </li> + <li>CIAO <a href="releasenotes/index.html">Status (aka. release +notes.)</a></li> + <li>CIAO <a href="EnvVars.html">Environment Variables</a> <br> + </li> + <li>CIAO <a href="Trace.html">Logging Facility</a><br> + </li> + <li>CIAO <a href="../NEWS">NEWS</a></li> +</ul> +<hr> +<ul> +</ul> +<ul> + <p><!-- -<!-- <li>This <a href="new_components.html">page on implementing new + component</a> explains all the user-defined and tool-generated + files when implementing a component.<p> + + <li>The <a href="ConfigValues.html">Configuration Name/Value + lists</a> lists all the configuration values that CIAO will pass + into vaious CCM mechanisms. The information shown in this page + is not visible to CIAO end-users, which include modeling tool + developers. The information that matters for most users is how + these configurations are represented in various XML + descriptors and CIDL specifications.<p> + --> - <li>CIAO uses some <a href="EnvVars.html">environment variables</a> - to manage the internal behaviors. + </p> </ul> - <h2>CCM-defined Interface Diagrams</h2> - Here is a set of UML diagrams that we use to figure out the -relationship among all the different interfaces in CCM. You can +relationship among all the different interfaces in CCM. You can browse the related part from the following list: - -<UL> - <li><a href="imgs/component-basic.png"> Basic component interfaces - </a></li> +<ul> + <li><a href="imgs/component-basic.png"> Basic component interfaces </a></li> <li><a href="imgs/home-config.png"> Home and configuration interfaces - </a></li> - <li><a href="imgs/basic-container.png"> Basic container interfaces - </a></li> + </a></li> + <li><a href="imgs/basic-container.png"> Basic container interfaces </a></li> <li><a href="imgs/extended-container.png"> Extended container - interfaces </a></li> - <li><a href="imgs/deployment.png"> Deployment and configuration (DAnCE) - interfaces </a></li> -</UL> -All these diagrams are generating from the <a href="imgs/CCM.vsd">CCM.vsd -Visio file</a> (The same file in Visio V.5 format is <a href="imgs/CCM-v5.vsd">here</a>.) - +interfaces </a></li> + <li><a href="imgs/DAnCE-Dynamic.png"> Deployment and configuration +(DAnCE) interfaces </a></li> +</ul> +All these diagrams are generated from the <a href="imgs/CCM.vsd">CCM.vsd +Visio file</a> (The same file in Visio V.5 format is <a + href="imgs/CCM-v5.vsd">here</a>.) and OpenOffice source file + <a href="imgs/DAnCE-Dynamic.sxd">DAnCE-Dynamic.sxd</a> <br> +<br> +<hr> <h2>CIAO's D&C Framework (DAnCE) part-by-part</h2> - -Here is a list of the major elements of CIAO that a user should be aware of. - -<UL> - <li><a href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/tools/daemon/index.html"><strong>Daemon:</strong></a> A CIAO Daemon is the per-host Daemon process which is used to create/spawn the ComponentServer.</li><P> - - <li><a href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/ciao/index.html"><strong>ComponentServer:</strong></a> A ComponentServer is the center part of CIAO. It's responsible for component/home creation.</li><P> - - <li><a href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/tools/assembly_deployer/index.html"><strong>AssemblyDeployer:</strong></a> An AssemblyDeployer is responsible for starting the Assembly process.</li><P> - - <li><a href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/tools/assembly_deployer/index.html"><strong>AssemblyManager:</strong></a> An AssemblyManager is the center part to do the Assembly work.</li><P> - - <li><a href="static_ciao_index.html"><strong>Static Configurator:</strong> </a>The CIAO -Static Configurator acts as a pre-processor that parses the XML descriptor -files into intermediate representation that gets linked into the main application. -This reduces the initialization time for an application that is statically -built. It is mainly aimed at RTOS' like VxWorks that lacks facilities like -shared objects or DLL.</li> -</UL> - - +Here is a list of the major actors of CIAO runtime that a user should +be aware of. +<ul> + <li><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/dance/dir_000011.html"><strong>NodeManager:</strong></a> +A daemon process responsible for managing NodeApplications that reside +in the same physical node.</li> + <p> </p> + <li><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/dance/dir_000007.html"><strong>NodeApplicationManager:</strong></a> +A infrastructure component responsible for deploying +locality-constrained applications onto a node. A NodeApplicationManager +is usually created by NodeManager.<br> + </li> + <p> </p> + <li><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/dance/dir_000013.html"><strong>NodeApplication:</strong></a> +A component server instance spawned by NodeApplicationManager. <br> + </li> + <p> </p> + <li><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/dance/dir_000008.html"><strong>ExecutionManager:</strong></a> +Infrastructure component responsible for executing an component-based +DRE application based on the information from DeploymentPlan.</li> + <p> </p> + <li><strong><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/dance/dir_000010.html"><strong>DomainApplicationManager</strong></a></strong>: +Domain-oriented auxiliary component created and used by +ExecutionManager to deploy the component-based DRE application at the +domain level. <br> + <br> + </li> + <li><strong><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/tools/assembly_deployer/index.html"><strong></strong></a></strong><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/tools/assembly_deployer/index.html"><strong></strong></a><strong><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/tools/assembly_deployer/index.html"><strong></strong></a></strong><strong><a + href="http://www.dre.vanderbilt.edu/Doxygen/Current/html/tao/ciao/dance/dir_000009.html"><strong>PlanLauncher</strong></a></strong><strong>: + </strong>Executor component responsible for parsing the XML-based +deploymentplan and passing the plan to ExecutionManager for execution.<br> + <br> +To understand the runtime inter-relationships of various CIAO actors, +you may click <a href="imgs/DAnCE-Dynamic.png">here</a> to see a +sequence diagram that gives you a clear representation of what's +happening when you start a DAnCE-based DRE application. Special thanks +to <a href="mailto:Friedhelm.wolf@gmx.de">Friedhelm Wolf</a> who +initiated and contributed most part of this +diagram.<br> + <br> + </li> +</ul> +<hr> <h2>CIAO CCM tutorials</h2> - There are several tutorials to help you understand CIAO and CCM: - -<UL> -<LI> <A - HREF="http://www.cs.wustl.edu/~schmidt/OMG-CCM-Tutorial.ppt">Tutorial -on the CORBA Component Model (CCM)</A>. This tutorial presents an overview of the CORBA Component Model (CCM), +<ul> + <li> <a + href="http://www.cs.wustl.edu/%7Eschmidt/OMG-CCM-Tutorial.ppt">Tutorial +on the CORBA Component Model (CCM)</a>. This tutorial presents an +overview of the CORBA Component Model (CCM), describing its key features and illustrating how to write CCM -applications in C++. <P> - - <li><a -href="../examples/Hello"><code>$(CIAO_ROOT)/DAnCE/examples/Hello.</code></a> -This example illustrates how to build and deploy a CIAO based application <a -href="../DAnCE/examples/Hello/step-by-step.html">step-by-step</a>. There is -also a detailed documentation explaining this example avalable in both -<a href="http://www.dre.vanderbilt.edu/~dengg/CCM/CCM_Hello_example.pdf"> -PDF</a> and <a -href="http://www.dre.vanderbilt.edu/~dengg/CCM/CCM_Hello_example.ppt"> -PowerPoint</a> format.</li> - -</UL> - - -<!--#include virtual="/~nanbor/signature.html" --> -<!-- <hr> --> -<!-- <\!-- hhmts start -\-> --> -<!-- Last modified: Mon Nov 04 07:55:22 Central Standard Time 2002 --> -<!-- <\!-- hhmts end -\-> --> -<!-- <address>Nanbor Wang <nanbor@cs.wustl.edu></address> --> -</body> </html> +applications in C++. + <p> </p> + </li> + <li><a href="../examples/Hello"><code>$(CIAO_ROOT)/DAnCE/examples/Hello.</code></a> +This example illustrates how to build and deploy a CIAO based +application <a href="../DAnCE/examples/Hello/step-by-step.html">step-by-step</a>. +There is +also a detailed documentation explaining this example avalable in both <a + href="http://www.dre.vanderbilt.edu/%7Edengg/CCM/CCM_Hello_example.pdf">PDF</a> +and <a + href="http://www.dre.vanderbilt.edu/%7Edengg/CCM/CCM_Hello_example.ppt"> +PowerPoint</a> format.<br> + <br> + </li> + <li><a href="./tutorials/Quoter/Simple">$(CIAO_ROOT)/docs/tutorials/Quoter/Simple</a>. +This example illustrates the implementation of the "famous" Quoter +example in the CIAO world. Please refer to <a + href="tutorials/Quoter/Simple/README.html">README</a> for more +information. </li> +</ul> +<!--#include virtual="/~nanbor/signature.html" --><!-- <hr> --><!-- <\!-- hhmts start -\-> --><!-- Last modified: Mon Nov 04 07:55:22 Central Standard Time 2002 --><!-- <\!-- hhmts end -\-> --> +<!-- <address>Nanbor Wang <nanbor@cs.wustl.edu></address> --><!-- LocalWords: CCM UML vsd Visio -<!-- LocalWords: CCM UML vsd Visio --> +</body> +</html> |
