Documentation for the new release

2 files changed, 74 insertions, 5 deletions

diff --git a/BUGS b/BUGS
index 74044fe..29a4baf 100644
--- a/BUGS
+++ b/BUGS
@@ -1,14 +1,46 @@
+-------------------------------------------------------------------------------------
+TODO List:
+
+  * ivyprobe is a bit touchy about being fed somethin on standard input
+    try echo "coucou" | ivyprobe ...
+  * document the new features of IvyClient, the extension to the API
+  * document the IVY_PING feature
+
+-------------------------------------------------------------------------------------
 Known bugs:
 
-  * it seems not to work with jdk1.1.7A VM.
+  * it seems not to work with jdk1.1.7A VM. ( Yannick Jestin, François Regis Colin)
+  * bus domain shortcuts ( 10:3456 instead of 10.255.255.255:3456  ) doesnt work
+    (Yannick Jestin)
 
+-------------------------------------------------------------------------------------
 Fixed:
 
+1.0.12
+   - implement .die in Probe ( to get the same behavior as ivy-c ivyprobe ) .
+     Done
+   - Probe doesn't send empty strings -> it does now
+   - the Unitary test fr.dgac.ivy.Ivy main() fails with jdk1.3, but succeeds with 1.4
+     it means that when a remote client disconnects brutally, the IvyClient and IvyWatcher
+     Threads are still hanging, ready for a new connexion !
+     In jdk1.3.0, it works whithin jdb but not as a single application
+     -> fixed with a new setSoTimeout(TIMEOUTLENGTH) on each socket.
+
+   - jdk1.4 DEBUG TCP socket reader caught an exception Socket closed on Ivy.close()
+   - if a remote client disconnect brutally ( broken pipe ), the BufferedReader
+     takes time to propagate the IOException. It means we are not aware of the
+     problem before 2 or 3 messages ( Alexandre Lemort )
+     there is a fix in IvyClient, but this is part of the TCP protocol. I will
+     receive the timeout when I try to write on the client. To circumvent this, I
+     have implemented an extention in the Ivy protocol with 2 new messages, Ping
+     and Pong. This is Ivy-java only, and and experimental feature.
+   - when a Ivy bus sends a die message, he dies instead of making the other leave
   * 1.0.11: received an exception: IvyClient.sendBuffer.write failed: Relais brisé (pipe)
   It happens while sending messages once a remote client has disconnected
   ( fixed in 1.0.12 )
 
-Not a bug
+-------------------------------------------------------------------------------------
+Not a bug ?
 
   if you send a msg just after the start, it is possible that the message
   won't be sent. this is *not* a bug, but, hmmm, a feature. In fact, when you
diff --git a/Changelog b/Changelog
index bddb117..4e048b5 100644
--- a/Changelog
+++ b/Changelog
@@ -1,10 +1,47 @@
 ----------------------------------------------------------------------------------------
 1.0.12
 
- IvyClient.sendBuffer update with silent error on a broken pipe, unless IVY_DEBUG is set
- Ivy.libVersion goes private static final
- IvyClient gets removed from the list of clients if there is a broken pipe.
+ bugfix:
+   IvyClient if a remote client disconnect brutally ( broken pipe ), the BufferedReader
+   takes time to propagate the IOException. It means we are not aware of the
+   problem before 2 or 3 messages ( Alexandre Lemort )
+   there is a fix in IvyClient, but this is part of the TCP protocol. I will
+   receive the timeout when I try to write on the client. To circumvent this, I
+   have implemented an extention in the Ivy protocol with 2 new messages, Ping
+   and Pong. This is Ivy-java only, and and experimental feature.
+
+ Probe
+   Probe can now send empty strings on keyboard input
+   rewritten with a looping thread on stdin to allow a cleaner exit on die
+     message : not very good
+   processes .help, .die , .quit and .bye commands
+   it is possible to rename the JPROBE on the bus with the -n switch, it can
+     circumvent name collisions during tests
+     e.g: java fr.dgac.ivy.Probe -n JPROBE2
+
+ Ivy
+   setSoTimeout is back on the server socket
+   added a regression test main()
+   clients is now a Hashtable. the deletion now works better
+   getIvyClientsByName allows the research of IvyClient by name
+   getDomain doesnt throw IvyException anymore
+   removed the close() disconnect(IvyClient c). Fixes a big badaboum bug
+   getDomain becomes public
+   adding the sendToSelf feature
+   fixed the printStackTrace upon closing of the ServerSocket after a close()
+
+ IvyException changed default access constructor to public access
+
+ IvyApplicationAdapter missed an id in the parameters
+
+ IvyClient
+   sendDie() methode goes public
+   sendBuffer update with silent error on a broken pipe, unless IVY_DEBUG is set
+   the IvyClient gets removed from the list of clients if there is a broken pipe.
    Another bug fixed !
+   implements ping and pong protocol
+   appName visibility changed from private to protected
+
  IvyDaemon is granted a public access on its constructor
 
 ----------------------------------------------------------------------------------------