home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / njpipes.zip / readme.txt < prev    next >
Text File  |  1999-05-30  |  7KB  |  147 lines
  1.  
  2. Pipes for NetRexx and Java                           Version 0.48  May 16, 1999
  3.  
  4.  
  5. Copyright (c) E. J. Tomlinson <tomlins@cam.org>, 1997.  All rights reserved
  6.  
  7.  
  8.     This code is Beta and will contain bugs.  Use it at your own risk.
  9.  
  10.     Pipes for Netrexx and Java is PROVIDED AS IS AND COMES WITH NO WARRANTY OF
  11.     ANY KIND, EITHER EXPRESSED OR IMPLIED.  IN NO EVENT WILL THE COPYRIGHT
  12.     HOLDER BE LIABLE FOR ANY DAMAGES RESULTING FROM THE USE OF THIS SOFTWARE.
  13.  
  14.     Parts of njPipes are Distributed under the GNU GENERAL PUBLIC LICENSE with
  15.     NO WARANTEES of ANY kind. See CopyLeft.Txt for the licence and information
  16.     on using, copying, modifing, and distributing this program.
  17.  
  18.     Not withstanding the above disclaimers, I am very interested in suggestions,
  19.     problems, bugs, and questions.
  20.  
  21. Installation and Requirements
  22.  
  23.     To run Pipes for NetRexx and Java you need both Java and NetRexx runtime
  24.     support installed.  To write your own pipes or stages you need compilers for
  25.     both Java and NetRexx.  The OS2 JDK release for JAVA 1.1.7A and NetRexx 1.148
  26.     where used to develop this code.  NetRexx 1.132 is required to use version
  27.     025 and above as inner classes are used.
  28.  
  29.     The installation has changed in release 025.  The core classes for pipes
  30.     and stages have been moved into njpipesC.jar.  This file may be added to your
  31.     your CLASSPATH.
  32.  
  33.     To install create an njpipes directory, cd into it and unzip njpipes.zip.
  34.     Then unzip the versioned njpipes file, unzip njpipes046.zip.  This will build
  35.     the directory structure with with examples, docuementation, the njpipesC.jar,
  36.     a pipe.bat and pipe.cmd.  If you unzipped on a drive other than C: or you
  37.     placed njpipes in a subdirectory, edit the .bat (W95, NT) or the .cmd (OS/2)
  38.     file to point to your njpipes.jar and you can start pipeing.
  39.  
  40.     Alternately you can add njpipesC.jar to your CLASSPATH.
  41.  
  42.     For NT the following variables or their equivalent need to be defined in the
  43.     Control Panel, System, Environment page as user variables.  This assumes
  44.     you are using the sun <a href="http://java.sun.com/products/jdk/1.1/">JDK</a> with the performance pack applied.
  45.  
  46.     CLASSPATH = c:\jdk1.1.6\lib\NetRexxC.zip;c:\njpipes\njpipesC.jar;c:\NetRexx;.;c:\jdk1.1.6\lib\classes.zip
  47.     JAVA_COMPILER = symcjit
  48.     PATH = C:\jdk1.1.6\bin;.;
  49.  
  50.     To test your installation CD into the njpipes directory and type:
  51.  
  52.     (W95, NT)
  53.  
  54.     pipe "(test) literal arg() ! dup 999 ! count words ! console"
  55.  
  56.     (OS/2)
  57.  
  58.     pipe "(test) literal arg() ! dup 999 ! count words ! console"
  59.  
  60.     The first time you use the pipe command in a new directory it will
  61.     create a default pipes.cnf file for you.
  62.  
  63.     If you have added the njpipes.jar to your CLASSPATH you can also use:
  64.  
  65.     java pipes.compiler (test) literal arg() ! dup 999 ! count words ! console
  66.  
  67.     You should see a message that the pipe compiler is processing your pipe and
  68.     soon after that messages from the NetRexx compiler as it processes the pipe.
  69.  
  70.     To run the pipe type:
  71.  
  72.     java test some words
  73.  
  74.     The pipe should then output:
  75.  
  76.     2000
  77.  
  78. |   If you have had njPipes working and it fails after a reinstall, it may be
  79. |   due to source you have recompiled.  Its a good idea to delete any .class
  80. |   files you have created in the pipes, stages or tests directories.  Also
  81. |   check the readme.  There maybe requirements to recompile some of your
  82. |   pipes.  The stageExit method, now used quite a bit, is a two edged sword.
  83. |   On one hand it generates much faster pipes, on the other hand, it often
  84. |   requires pipes to be recompiled.
  85.  
  86. Recient History
  87.  
  88.    0.50  - Released May 30, 1999
  89.          - Fixed a stall occuring when interruped threads, with the interrupt
  90.            caught by ThreadPool, were reused.
  91.          - Fixed a thread safety problem in ELASTIC
  92.          - Improved the timeout options in TCPDATA and TCPCLIENT, they also
  93.            byte[] instead of strings.  This was done since converting to and
  94.            from strings sometimes scrambles binary data (more research on
  95.            encodings...)
  96.          - Changed DELBLOCK it now handles byte[] to help keep tcpdata andn
  97.            tcpclient efficent.  The EOF option was broken, its fixed now.
  98.          - Changed DISKR, DISKW and DISKA to handle byte[] when using streams.
  99.          - Added INSERT which handles byte[].  This should be used instead of
  100.            SPECS to add LF or CR .
  101.    0.49  - Released May 21, 1999
  102.          - compiled with 1.2.1 and netrexx 1.148
  103.          - Added preliminary support added to .njp compiler for files containing
  104.            java source!  See the (some what messy) java samples in vectort1.njp,
  105.            overtest.njp and addtest4.njp
  106.          - Added code to generate a dummy .nrx file containing the public class
  107.            in a .java file.  This allows NetRexx to compile class that depend on
  108.            the java source.
  109.          - Modified sort to accept arguements in the same order as CMS
  110.          - Fixed rc logic in drop stage
  111.          - Fixed shortcut code for {n} where n is numeric.
  112.    0.48  - Released May 16, 1999
  113.          - Fixed a (nasty) bug involving reusing pipe objects.
  114.          - Added the reuse() method to the stage class.  To use it override
  115.            it in your stage.  It was added so there was a foolproof way to
  116.            reset a stage when its pipe object is reused.  (doSetup is intended
  117.            for use with dynamic arguements in call or added pipes)
  118.          - Added the cont option and defaulted it to comma.
  119.          - fixed return code logic in some stages and in selectInput/Output
  120.          - Added the Emsg methods
  121.          - Added arguement debug option (128)
  122.          - Changed stages so the run methods are not final
  123.  
  124.     Planned for the next month or three (pending BUGS! and my time)
  125.  
  126.     0.xx - make pipe objects java beans.
  127.     0.xx - implement the new StageError/Emsg code in all stages
  128.     0.xx - rewrite the stage class to use notifyAll/wait to pass data and
  129.            interrupt to pass flow control info (ie. severs...).  This will
  130.            result in an implementation that is easier to understand and
  131.            maintain.
  132.  
  133. Trademarks
  134.  
  135.     Java is a trademark of Sun Microsystems
  136.  
  137.     Windows NT is a trademark of MicroSoft
  138.  
  139.     The following terms, are trademarks or registered
  140.     trademarks of IBM Corporation in the United States and/or other countries:
  141.  
  142.     IBM
  143.     OS/2
  144.     NetRexx
  145.     CMS
  146.  
  147.