incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hamm...@apache.org
Subject cvs commit: incubator-altrmi/src/documentation/content/xdocs credits.xml monitors.xml client-usage.xml facades.xml generating-proxies.xml index.xml otherfeatures.xml pingers.xml publishing.xml site.xml tests.xml transports.xml book-sample.xml connection-listeners.xml tabs.xml
Date Sat, 29 Mar 2003 21:47:27 GMT
hammant     2003/03/29 13:47:27

  Modified:    src/documentation/content/xdocs client-usage.xml facades.xml
                        generating-proxies.xml index.xml otherfeatures.xml
                        pingers.xml publishing.xml site.xml tests.xml
                        transports.xml
  Added:       src/documentation/content/xdocs credits.xml monitors.xml
  Removed:     src/documentation/content/xdocs book-sample.xml
                        connection-listeners.xml tabs.xml
  Log:
  Work on docs
  
  Revision  Changes    Path
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/client-usage.xml
  
  Index: client-usage.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/client-usage.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- client-usage.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ client-usage.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Client Usage</title>
  +    <title>Client-side Usage</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/facades.xml
  
  Index: facades.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/facades.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- facades.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ facades.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Facade Design</title>
  +    <title>Facade Design</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/generating-proxies.xml
  
  Index: generating-proxies.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/generating-proxies.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- generating-proxies.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ generating-proxies.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Facade Design</title>
  +    <title>Facade Design</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.5       +2 -2      incubator-altrmi/src/documentation/content/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/index.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- index.xml	15 Mar 2003 23:54:39 -0000	1.4
  +++ index.xml	29 Mar 2003 21:47:26 -0000	1.5
  @@ -24,7 +24,7 @@
           replacements, but for now we stick with AltRMI.
         </p>
         <p>
  -        The mail list for this project is projects@incubator.apache.org. Subscribe 
  +        The mail list for this project is 'projects at incubator.apache.org'. Subscribe

           <link href="mailto:projects-subscribe@incubator.apache.org">here</link>.
Please mark your 
           emails with a subject of [altrmi] + your normal subject choice.
         </p>
  
  
  
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/otherfeatures.xml
  
  Index: otherfeatures.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/otherfeatures.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- otherfeatures.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ otherfeatures.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Other Features</title>
  +    <title>Other Features</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.4       +16 -3     incubator-altrmi/src/documentation/content/xdocs/pingers.xml
  
  Index: pingers.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/pingers.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- pingers.xml	16 Mar 2003 00:15:38 -0000	1.3
  +++ pingers.xml	29 Mar 2003 21:47:26 -0000	1.4
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Pingers</title>
  +    <title>Pingers</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  @@ -21,8 +21,21 @@
         <p>
           It is possible to write your own or extend the exiting 
           ones if there are different requirements.  The interface for bespoke pingers 
  -        is <link href="api/org/apache/altrmi/client/ConnectionPinger.html">here</link>
  +        is 'ConnectionPinger'
         </p>    
  +<source>
  +<![CDATA[
  +public interface ConnectionPinger
  +{
  +
  +    void setInvocationHandler( ClientInvocationHandler altrmiInvocationHandler );
  +
  +    void start();
  +
  +    void stop();
  +}
  +]]>
  +</source>      
       </section>          
       <section >    
         <title>Pinger types</title>
  
  
  
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/publishing.xml
  
  Index: publishing.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/publishing.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- publishing.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ publishing.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Publishing</title>
  +    <title>Publishing Interfaces</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.2       +2 -1      incubator-altrmi/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- site.xml	16 Feb 2003 15:56:57 -0000	1.1
  +++ site.xml	29 Mar 2003 21:47:26 -0000	1.2
  @@ -8,6 +8,7 @@
       <item href="transports.html" label="Transports"/>    
       <faq label="FAQ" href="faq.html"/>
       <changes label="Changes" href="changes.html"/>
  +    <todo label="Credits" href="credits.html"/>
       <todo label="Todo" href="todo.html"/>
     </about>
     
  @@ -17,7 +18,7 @@
       <item href="publishing.html" label="Publishing"/>
       <item href="client-usage.html" label="Client usage"/>
       <item href="pingers.html" label="Pingers"/>
  -    <item href="connection-listeners.html" label="Connection Listeners"/>
  +    <item href="monitors.html" label="Monitors"/>
       <item href="tests.html" label="Tests"/>  
     </about>  
   
  
  
  
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/tests.xml
  
  Index: tests.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/tests.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- tests.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ tests.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Tests</title>
  +    <title>Tests</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.3       +2 -2      incubator-altrmi/src/documentation/content/xdocs/transports.xml
  
  Index: transports.xml
  ===================================================================
  RCS file: /home/cvs/incubator-altrmi/src/documentation/content/xdocs/transports.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- transports.xml	16 Feb 2003 21:41:35 -0000	1.2
  +++ transports.xml	29 Mar 2003 21:47:26 -0000	1.3
  @@ -2,7 +2,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     <header>
  -    <title>AltRMI / Transports</title>
  +    <title>Pluggable Transports</title>
       <authors>
         <person name="Paul Hammant" email=""/>
       </authors>
  
  
  
  1.1                  incubator-altrmi/src/documentation/content/xdocs/credits.xml
  
  Index: credits.xml
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
    <header>
      <title>Credits</title>
      <authors>
        <person name="Paul Hammant" email=""/>
      </authors>
    </header>
    <body>
      <section >
        <title>Coders who've worked on AltRMI</title>
        <p>
          A broad group of people have contributed at various stages. Here listed in alphabetical
order:
        </p>
        <ol>
          <li>Benjamin David Hall (patch)</li>
          <li>Berin Loritsch</li>
          <li>Mauro Talevi (pairing)</li>
          <li>Mike Miller (patch submission)</li>
          <li>Paul Hammant</li>
          <li>Peter Royal</li>
          <li>Thomas Kiesgen (patch submission)</li>
          <li>Vinay Chandrasekharan</li>
        </ol>
      </section>       
      <section >
        <title>Forked code from other Apache projects</title>
        <p>
          We've borrowed code from elsewhere at Apache. Thus there are accidental authors:
        </p>
        <ol>
          <li>Anil K. Vijendran - JavaCompiler</li>
          <li>Costin Manolache - JavaCompiler</li>
          <li>Peter Donald - Dynamic Proxy</li>
          <li>Sam Ruby - JavaCompiler</li>
        </ol>
      </section>       
  
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Apache Incubator Project. All rights reserved.
        $Revision: 1.1 $ $Date: 2003/03/29 21:47:26 $
      </legal>
    </footer>
  </document>
  
  
  
  1.1                  incubator-altrmi/src/documentation/content/xdocs/monitors.xml
  
  Index: monitors.xml
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
    <header>
      <title>Monitors</title>
      <authors>
        <person name="Paul Hammant" email=""/>
      </authors>
    </header>
    <body>
      <section >
        <title>Introduction</title>
        <p>
          Both the server and client sides of AltRMI can be monitored.  After 
          instantiation, the Server of Factory have a setMonitor() methods.
        </p>
      </section>          
      <section >
        <title>Server Monitor</title>
        <p>    
          The interface for the ServerMonitor is :
        </p>
  <source>
  <![CDATA[
  public interface ServerMonitor {
  
      void closeError(Class clazz, String s, IOException e);
  
      void badConnection(Class clazz, String s, BadConnectionException bce);
  
      void classNotFound(Class clazz, ClassNotFoundException e);
  
      void unexpectedException(Class clazz, String s, Exception e);
  
      void stopServerError(Class clazz, String s, Exception e);
  }
  ]]>
  </source>
        <p>    
          You get to choose from a number of implementations.  NullServerMonitor
          consumes all monitored events.  LogEnabledServerMonitor, 
          CommonsLoggingServerMonitor and Log4JServerMonitor route through to the
          appropriate logging framework.  You do not have to tie the application 
          you develop (that needs to use AltRMI) to any particular logging 
          framework. If you so desire, you do not need any logging jar in 
          your classpath (or classloader tree for more complex deployments).
        </p>
      </section>          
      <section >
        <title>Client Monitor</title>
        <p>    
          The interface for the ClientMonitor is :
        </p>
  <source>
  <![CDATA[
  public interface ClientMonitor
  {
  
      void methodCalled(Class clazz, String methodSignature, long duration, String annotation
);
  
      boolean methodLogging();
  
      void serviceSuspended(Class clazz, Request altrmiRequest, int attempt, int suggestedWaitMillis
);
  
      void serviceAbend(Class clazz, int attempt, IOException cause);
  
      void invocationFailure(Class clazz, String name, InvocationException ie);
  
      void unexpectedClosedConnection(Class clazz, String name, ConnectionClosedException
cce);
  
      void unexpectedInterruption(Class clazz, String name, InterruptedException ie);
  }
  ]]>
  </source>
        <p> 
          The ClientMonitor has a couple of novel feautes over ServerMonitor (which just listens).
 
          The first is that timings for method calls can be reported on. As timing costs time,
the
          ClientMonitor reports whether it wants timing at all.  The second is that 
          serviceSuspend() and serviceAbend() encourages the implementor to join in 
          with whether the pending request will fail or try again.  It does this by throwing

          InvocationException. Different strategies (fail-fast, retry-forever) are possible,
but
          clearly they affect the way client code works.
        </p>
        <p>    
          As with the ServerMonitor, you get to choose from a number of implementations. 

          DumbClientMonitor consumes all monitored events without logging anything and 
          fails-fast for the two abend() and suspend() methods.  DefaultClientMonitor, 
          still logs nothing, but tries for a few attempts to reestablish a connection.
        </p>
      </section>       
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Apache Incubator Project. All rights reserved.
        $Revision: 1.1 $ $Date: 2003/03/29 21:47:26 $
      </legal>
    </footer>
  </document>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message