From 3a71af1001479418128803ed86428602bad9dd66 Mon Sep 17 00:00:00 2001
From: jestin
Date: Wed, 8 Aug 2001 15:14:16 +0000
Subject: Adding the html API documentation
---
doc/html/api/fr/dgac/ivy/Ivy.html | 590 +++++++++++++++++++++
.../api/fr/dgac/ivy/IvyApplicationAdapter.html | 296 +++++++++++
.../api/fr/dgac/ivy/IvyApplicationListener.html | 248 +++++++++
doc/html/api/fr/dgac/ivy/IvyClient.html | 223 ++++++++
doc/html/api/fr/dgac/ivy/IvyException.html | 166 ++++++
doc/html/api/fr/dgac/ivy/IvyMessageListener.html | 174 ++++++
6 files changed, 1697 insertions(+)
create mode 100644 doc/html/api/fr/dgac/ivy/Ivy.html
create mode 100644 doc/html/api/fr/dgac/ivy/IvyApplicationAdapter.html
create mode 100644 doc/html/api/fr/dgac/ivy/IvyApplicationListener.html
create mode 100644 doc/html/api/fr/dgac/ivy/IvyClient.html
create mode 100644 doc/html/api/fr/dgac/ivy/IvyException.html
create mode 100644 doc/html/api/fr/dgac/ivy/IvyMessageListener.html
(limited to 'doc/html/api/fr')
diff --git a/doc/html/api/fr/dgac/ivy/Ivy.html b/doc/html/api/fr/dgac/ivy/Ivy.html
new file mode 100644
index 0000000..3e44d3e
--- /dev/null
+++ b/doc/html/api/fr/dgac/ivy/Ivy.html
@@ -0,0 +1,590 @@
+
+
+
+
+
+
+: Class Ivy
+
+
+
+fr.dgac.ivy
+
+
+java.lang.Object
+ |
+ +--fr.dgac.ivy.Ivy
+
+
+All Implemented Interfaces: java.util.EventListener, IvyApplicationListener , java.lang.Runnable
+
+
+public class Ivy extends java.lang.Objectimplements java.lang.Runnable, IvyApplicationListener
+
+
+A class connecting to the Ivy software bus.
+ For example:
+
+Ivy bus = new Ivy("Dummy agent","ready",null);
+bus.bindMsg("(.*)",myMessageListener);
+bus.start(null);
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+ java.lang.String appName
+
+
+static java.lang.String DEFAULT_DOMAIN
+
+
+static int DEFAULT_PORT
+
+
+static int PROCOCOLVERSION
+
+
+
+
+
+
+
+Constructor Summary
+
+Ivy IvyApplicationListener appcb)
+
+
+
+
+
+
+
+Method Summary
+
+
+ int addApplicationListener IvyApplicationListener callback)
+
+
+ int bindMsg IvyMessageListener callback)
+
+
+ void connect IvyClient client)
+
+
+ void die IvyClient client,
+ int id)
+
+
+ void directMessage IvyClient client,
+ int id,
+ java.lang.String msgarg)
+
+
+ void disconnect IvyClient client)
+
+
+ void removeApplicationListener
+
+
+ void run
+
+
+ int sendMsg
+
+
+ void start
+
+
+ void stop
+
+
+ void unBindMsg
+
+
+
+Methods inherited from class java.lang.Object
+
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+appName
+
+public java.lang.String appName
+
+the name of the application on the bus
+
+PROCOCOLVERSION
+
+public static final int PROCOCOLVERSION
+
+the protocol version number
+
+DEFAULT_PORT
+
+public static final int DEFAULT_PORT
+
+the port for the UDP rendez vous, if none is supplied
+
+DEFAULT_DOMAIN
+
+public static final java.lang.String DEFAULT_DOMAIN
+
+the domain for the UDP rendez vous
+
+
+
+
+
+
+Constructor Detail
+
+
+
+Ivy
+
+public Ivy (java.lang.String name,
+ java.lang.String message,
+ IvyApplicationListener appcb)
+
+Readies the structures for the software bus connexion.
+
+ All the dirty work is done un the start() method
+Parameters: name - The name of your Ivy agent on the software busmessage - The hellow message you will send once readyappcb - A callback handling the notification of connexions and
+ disconnections, may be nullSee Also: start(java.lang.String)
+
+
+
+
+
+start
+
+public void start (java.lang.String domainbus)
+ throws IvyException
+
+connects the Ivy bus to a domain or list of domains
+
+
+Parameters: domainbus - a domain of the form 10.0.0:1234, it is similar to the
+ netmask without the trailing .255. This will determine the meeting point
+ of the different applications. Right now, this is done with an UDP
+ broadcast. Beware of routing problems ! You can also use a comma
+ separated list of domains.
+
+
+stop
+
+public void stop ()
+
+disconnects from the Ivy bus.
+ TODO is there a bug here ? There is still a thread running and a
+ standalone application won't quit here.
+
+
+
+sendMsg
+
+public int sendMsg (java.lang.String message)
+
+Performs a pattern matching according to everyone's regexps, and sends
+ the results to the relevant ivy agents.
+ There is one thread for each client connected, we could also
+ create another thread each time we send a message.
+
+
+Parameters: message - A String which will be compared to the regular
+ expressions of the different clientsReturns: the number of messages actually sent
+
+
+bindMsg
+
+public int bindMsg (java.lang.String regexp,
+ IvyMessageListener callback)
+
+Subscribes to a regular expression.
+
+ The callback will be executed with
+ the saved parameters of the regexp as arguments when a message will sent
+ by another agent. A program doesn't receive its own messages.
+ Example:
+
b.bindMsg("^Hello (*)",cb);
+ b2.sendMsg("Hello world");
+
+
+
+Parameters: regexp - a perl regular expression, groups are done with parenthesiscallback - any objects implementing the IvyMessageListener
+ interface, on the AWT/Swing frameworkReturns: the id of the regular expression
+
+
+unBindMsg
+
+public void unBindMsg (int id)
+ throws IvyException
+
+unsubscribes a regular expression
+
+
+Parameters: id - the id of the regular expression, returned when it was bound
+
+
+addApplicationListener
+
+public int addApplicationListener (IvyApplicationListener callback)
+
+adds an application listener to a bus
+
+
+Parameters: callback - is an object implementing the IvyApplicationListener
+ interfaceReturns: the id of the application listener, useful if you wish to remove
+ it later
+
+
+removeApplicationListener
+
+public void removeApplicationListener (int id)
+
+removes an application listener
+
+
+Parameters: id - the id of the application listener to remove
+
+
+connect
+
+public void connect (IvyClient client)
+
+Description copied from interface: IvyApplicationListener invoked when a Ivy Client has joined the bus
+Specified by: connect IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peer
+
+
+disconnect
+
+public void disconnect (IvyClient client)
+
+Description copied from interface: IvyApplicationListener invoked when a Ivy Client has left the bus
+Specified by: disconnect IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peer
+
+
+die
+
+public void die (IvyClient client,
+ int id)
+
+Description copied from interface: IvyApplicationListener invoked when a peer request us to leave the bus
+Specified by: die IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peer
+
+
+directMessage
+
+public void directMessage (IvyClient client,
+ int id,
+ java.lang.String msgarg)
+
+Description copied from interface: IvyApplicationListener invoked when a peer sends us a direct message
+Specified by: directMessage IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peerid - msgarg - the message itself
+ this is not yet implemented in java. I believe it has no real use :)
+
+
+run
+
+public void run ()
+
+
+Specified by: run in interface java.lang.Runnable
+
+
+
+: Class IvyApplicationAdapter
+
+
+
+fr.dgac.ivy
+
+
+java.lang.Object
+ |
+ +--fr.dgac.ivy.IvyApplicationAdapter
+
+
+All Implemented Interfaces: java.util.EventListener, IvyApplicationListener
+
+
+public abstract class IvyApplicationAdapter extends java.lang.Objectimplements IvyApplicationListener
+
+
+this class is a dummy ApplicationListener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+ void connect IvyClient client)
+
+
+ void die IvyClient client)
+
+
+ void directMessage IvyClient client,
+ int id,
+ java.lang.String msgarg)
+
+
+ void disconnect IvyClient client)
+
+
+
+Methods inherited from class java.lang.Object
+
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+IvyApplicationAdapter
+
+public IvyApplicationAdapter ()
+
+
+
+
+
+
+connect
+
+public void connect (IvyClient client)
+
+Description copied from interface: IvyApplicationListener invoked when a Ivy Client has joined the bus
+Specified by: connect IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peer
+
+
+disconnect
+
+public void disconnect (IvyClient client)
+
+Description copied from interface: IvyApplicationListener invoked when a Ivy Client has left the bus
+Specified by: disconnect IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peer
+
+
+die
+
+public void die (IvyClient client)
+
+
+
+
+
+directMessage
+
+public void directMessage (IvyClient client,
+ int id,
+ java.lang.String msgarg)
+
+Description copied from interface: IvyApplicationListener invoked when a peer sends us a direct message
+Specified by: directMessage IvyApplicationListener
+Following copied from interface: fr.dgac.ivy.IvyApplicationListener
+
+Parameters: client - the peerid - msgarg - the message itself
+ this is not yet implemented in java. I believe it has no real use :)
+
+
+
+: Interface IvyApplicationListener
+
+
+
+fr.dgac.ivy
+
+
+All Superinterfaces: java.util.EventListener
+
+
+All Known Implementing Classes: IvyApplicationAdapter , Ivy
+
+public interface IvyApplicationListener extends java.util.EventListener
+
+
+this interface specifies the methods of an ApplicationListener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+ void connect IvyClient client)
+
+
+ void die IvyClient client,
+ int id)
+
+
+ void directMessage IvyClient client,
+ int id,
+ java.lang.String msgarg)
+
+
+ void disconnect IvyClient client)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+connect
+
+public void connect (IvyClient client)
+
+invoked when a Ivy Client has joined the bus
+
+
+Parameters: client - the peer
+
+
+disconnect
+
+public void disconnect (IvyClient client)
+
+invoked when a Ivy Client has left the bus
+
+
+Parameters: client - the peer
+
+
+die
+
+public void die (IvyClient client,
+ int id)
+
+invoked when a peer request us to leave the bus
+
+
+Parameters: client - the peer
+
+
+directMessage
+
+public void directMessage (IvyClient client,
+ int id,
+ java.lang.String msgarg)
+
+invoked when a peer sends us a direct message
+
+
+Parameters: client - the peerid - msgarg - the message itself
+ this is not yet implemented in java. I believe it has no real use :)
+
+
+
+: Class IvyClient
+
+
+
+fr.dgac.ivy
+
+
+java.lang.Object
+ |
+ +--java.lang.Thread
+ |
+ +--fr.dgac.ivy.IvyClient
+
+
+All Implemented Interfaces: java.lang.Runnable
+
+
+public class IvyClient extends java.lang.Thread
+
+
+A private Class for the the peers on the bus.
+
+
+
+
+
+
+
+
+
+Fields inherited from class java.lang.Thread
+
+MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+ void delRegexp
+
+
+ void run
+
+
+
+Methods inherited from class java.lang.Thread
+
+activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, sleep, sleep, start, stop, stop, suspend, toString, yield
+
+
+
+Methods inherited from class java.lang.Object
+
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+delRegexp
+
+public void delRegexp (int id)
+
+
+
+run
+
+public void run ()
+
+the code of the thread handling the incoming messages.
+ this thread stops (at least it should) when the socket is closed
+ or when gardefou=false
+Overrides: run in class java.lang.Thread
+
+
+
+: Class IvyException
+
+
+
+fr.dgac.ivy
+
+
+java.lang.Object
+ |
+ +--java.lang.Throwable
+ |
+ +--java.lang.Exception
+ |
+ +--fr.dgac.ivy.IvyException
+
+
+All Implemented Interfaces: java.io.Serializable
+
+
+public class IvyException extends java.lang.Exception
+
+
+signals that an unrecoverrable Ivy exception has occured.
+
+
+See Also: Serialized Form
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Methods inherited from class java.lang.Throwable
+
+fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
+
+
+
+Methods inherited from class java.lang.Object
+
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+: Interface IvyMessageListener
+
+
+
+fr.dgac.ivy
+
+
+All Superinterfaces: java.util.EventListener
+
+
+public interface IvyMessageListener extends java.util.EventListener
+
+
+this interface specifies the methods of an IvyMessageListener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+ void receive IvyClient client,
+ java.lang.String[] args)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+receive
+
+public void receive (IvyClient client,
+ java.lang.String[] args)
+
+this callback is invoked when a message has been received
+
+
+Parameters: client - the peer who sent the messageargs - the array of string, on string for each subregexp
+
+
+