include the javadoc jar in the dist
[lwes-java.git] / README
blobab0955fff5bec9ea88a69c7a4977e29ceeaf687e
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 ***
13 To increase the read buffer size on the multicast socket, set the system property
14 MulticastReceiveBufferSize. For example,
16 java -DMulticastReceiveBufferSize=8388608 ...
18 ***
19 0.2.1 -> 0.2.2 Changes
20 - If the size of the event is too large an EventSizeException will be thrown
21 instead of an EventSystemException.
22 - Fixed a bug with the MulticastEventEmitter where it was closing the socket
23 before calling super.shutdown which was trying to send a System::Shutdown message.
24 - Added the ability to set a maximum capacity on the internal queue used by the
25 ThreadedProcessor. If you set the queue size, you can avoid out of memory exceptions,
26 but you run the risk of dropping events on the floor (it would depend on how fast
27 you are processing events and how big your network buffer is).
29 ***
30 0.1.1 -> 0.2.0 Changes
31 - I removed the files that are autogenerated by javacc and made it part of the build.
32 The .java files will end up in target/generated-sources/javacc if you are interested in
33 seeing them.
35 - I also nuked the ant build.xml file. I don't want to support both ant and maven and imo,
36 maven wins. :)
38 - Added more unit tests
40 - Allow post event creation validation
42 - Use LinkedBlockingQueues where possible to retain event order and help synchronization.
44 - I removed AttributeNotSetException because throwing an exception if an attribute isn't set
45 in the event should not be the proper behavior (after all, HashMap and the like do not do this).