README

   1 This is the Java API for the Light Weight Event System.
   2
   3 ***
   4 Prerequisites
   5 - JDK 1.5.x (http://java.sun.com/)
   6 - Maven 2.2.x (http://apache.maven.org/)
   7
   8 ***
   9 How to build:
  10 % mvn clean package
  11
  12 To create a release:
  13 % mvn --batch-mode release:prepare release:perform
  14
  15 ***
  16 To increase the read buffer size on the multicast socket, set the system property
  17 MulticastReceiveBufferSize. For example,
  18
  19 java -DMulticastReceiveBufferSize=8388608 ...
  20
  21 ***
  22 1.0.0 Changes
  23 - New data types: byte, float, double, ipv4
  24 - Array support (Java implementation uses List)
  25 - Required/Optional
  26 - Size limitations
  27
  28 ***
  29 0.2.5
  30 Changed license to BSD.
  31
  32 ***
  33 0.2.4
  34 - There is a memory leak in jdk 1.6.0_20 and earlier in
  35 java.util.concurrent.LinkedBlockingQueue so I made a copy of that class and
  36 fixed the memory leak.
  37
  38 ***
  39 0.2.3
  40 - Allow one to override the size check that is done as part of the Event class. Size
  41 really only matters if one is intending on emitting the created event not if they
  42 are reading it from a file. Also allow introspection into Event to get the size in
  43 bytes.
  44
  45 ***
  46 0.2.1 -> 0.2.2 Changes
  47 - Added the ability to set a maximum capacity on the internal queue used by the
  48 ThreadedProcessor. If you set the queue size, you can avoid out of memory exceptions,
  49 but you run the risk of dropping events on the floor (it would depend on how fast
  50 you are processing events and how big your network buffer is).
  51
  52 ***
  53 0.1.1 -> 0.2.0 Changes
  54 - I removed the files that are autogenerated by javacc and made it part of the build.
  55 The .java files will end up in target/generated-sources/javacc if you are interested in
  56 seeing them.
  57
  58 - I also nuked the ant build.xml file. I don't want to support both ant and maven and imo,
  59 maven wins. :)
  60
  61 - Added more unit tests
  62
  63 - Allow post event creation validation
  64
  65 - Use LinkedBlockingQueues where possible to retain event order and help synchronization.
  66
  67 - I removed AttributeNotSetException because throwing an exception if an attribute isn't set
  68 in the event should not be the proper behavior (after all, HashMap and the like do not do this).