javadoc/assembly targets
[lwes-java.git] / README
blob52a07a1493a1031bad681c004fcb029dc6bd5569
1 This is the Java API for the Light Weight Event System.
3 ***
4 Prerequisites
5 - JDK 1.6.x (http://java.sun.com/)
6 - Maven 2.2.x (http://apache.maven.org/)
8 ***
9 How to build
10 % mvn clean package
12 If you want to create the distribution add the following targets:
14 javadoc:jar assembly:assembly
16 ***
17 To increase the read buffer size on the multicast socket, set the system property
18 MulticastReceiveBufferSize. For example,
20 java -DMulticastReceiveBufferSize=8388608 ...
22 ***
23 0.2.1 -> 0.2.2 Changes
24 - If the size of the event is too large an EventSizeException will be thrown
25 instead of an EventSystemException.
26 - Fixed a bug with the MulticastEventEmitter where it was closing the socket
27 before calling super.shutdown which was trying to send a System::Shutdown message.
28 - Added the ability to set a maximum capacity on the internal queue used by the
29 ThreadedProcessor. If you set the queue size, you can avoid out of memory exceptions,
30 but you run the risk of dropping events on the floor (it would depend on how fast
31 you are processing events and how big your network buffer is).
33 ***
34 0.1.1 -> 0.2.0 Changes
35 - I removed the files that are autogenerated by javacc and made it part of the build.
36 The .java files will end up in target/generated-sources/javacc if you are interested in
37 seeing them.
39 - I also nuked the ant build.xml file. I don't want to support both ant and maven and imo,
40 maven wins. :)
42 - Added more unit tests
44 - Allow post event creation validation
46 - Use LinkedBlockingQueues where possible to retain event order and help synchronization.
48 - I removed AttributeNotSetException because throwing an exception if an attribute isn't set
49 in the event should not be the proper behavior (after all, HashMap and the like do not do this).