README

   1 This is the Java API for the Light Weight Event System.
   2
   3 ***
   4 Prerequisites
   5 - JDK 1.6.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 If you want to create the distribution add the following targets:
  13
  14 javadoc:jar assembly:assembly
  15
  16 ***
  17 To increase the read buffer size on the multicast socket, set the system property
  18 MulticastReceiveBufferSize. For example,
  19
  20 java -DMulticastReceiveBufferSize=8388608 ...
  21
  22 ***
  23 0.2.3
  24 Allow one to override the size check that is done as part of the Event class. Size
  25 really only matters if one is intending on emitting the created event not if they
  26 are reading it from a file. Also allow introspection into Event to get the size in
  27 bytes.
  28
  29 ***
  30 0.2.1 -> 0.2.2 Changes
  31 - If the size of the event is too large an EventSizeException will be thrown
  32 instead of an EventSystemException.
  33 - Fixed a bug with the MulticastEventEmitter where it was closing the socket
  34 before calling super.shutdown which was trying to send a System::Shutdown message.
  35 - Added the ability to set a maximum capacity on the internal queue used by the
  36 ThreadedProcessor. If you set the queue size, you can avoid out of memory exceptions,
  37 but you run the risk of dropping events on the floor (it would depend on how fast
  38 you are processing events and how big your network buffer is).
  39
  40 ***
  41 0.1.1 -> 0.2.0 Changes
  42 - I removed the files that are autogenerated by javacc and made it part of the build.
  43 The .java files will end up in target/generated-sources/javacc if you are interested in
  44 seeing them.
  45
  46 - I also nuked the ant build.xml file. I don't want to support both ant and maven and imo,
  47 maven wins. :)
  48
  49 - Added more unit tests
  50
  51 - Allow post event creation validation
  52
  53 - Use LinkedBlockingQueues where possible to retain event order and help synchronization.
  54
  55 - I removed AttributeNotSetException because throwing an exception if an attribute isn't set
  56 in the event should not be the proper behavior (after all, HashMap and the like do not do this).