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/index-all.html | 224 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 doc/html/api/index-all.html (limited to 'doc/html/api/index-all.html') diff --git a/doc/html/api/index-all.html b/doc/html/api/index-all.html new file mode 100644 index 0000000..1a94220 --- /dev/null +++ b/doc/html/api/index-all.html @@ -0,0 +1,224 @@ + + + + + + +: Index + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES
+ + +A B C D I P R S U
+

+A

+
+
addApplicationListener(IvyApplicationListener) - +Method in class fr.dgac.ivy.Ivy +
adds an application listener to a bus +
appName - +Variable in class fr.dgac.ivy.Ivy +
the name of the application on the bus +
+
+

+B

+
+
bindMsg(String, IvyMessageListener) - +Method in class fr.dgac.ivy.Ivy +
Subscribes to a regular expression. + + +
+
+

+C

+
+
connect(IvyClient) - +Method in class fr.dgac.ivy.IvyApplicationAdapter +
  +
connect(IvyClient) - +Method in interface fr.dgac.ivy.IvyApplicationListener +
invoked when a Ivy Client has joined the bus +
connect(IvyClient) - +Method in class fr.dgac.ivy.Ivy +
  +
+
+

+D

+
+
DEFAULT_DOMAIN - +Static variable in class fr.dgac.ivy.Ivy +
the domain for the UDP rendez vous +
DEFAULT_PORT - +Static variable in class fr.dgac.ivy.Ivy +
the port for the UDP rendez vous, if none is supplied +
delRegexp(int) - +Method in class fr.dgac.ivy.IvyClient +
  +
die(IvyClient) - +Method in class fr.dgac.ivy.IvyApplicationAdapter +
  +
die(IvyClient, int) - +Method in interface fr.dgac.ivy.IvyApplicationListener +
invoked when a peer request us to leave the bus +
die(IvyClient, int) - +Method in class fr.dgac.ivy.Ivy +
  +
directMessage(IvyClient, int, String) - +Method in class fr.dgac.ivy.IvyApplicationAdapter +
  +
directMessage(IvyClient, int, String) - +Method in interface fr.dgac.ivy.IvyApplicationListener +
invoked when a peer sends us a direct message +
directMessage(IvyClient, int, String) - +Method in class fr.dgac.ivy.Ivy +
  +
disconnect(IvyClient) - +Method in class fr.dgac.ivy.IvyApplicationAdapter +
  +
disconnect(IvyClient) - +Method in interface fr.dgac.ivy.IvyApplicationListener +
invoked when a Ivy Client has left the bus +
disconnect(IvyClient) - +Method in class fr.dgac.ivy.Ivy +
  +
+
+

+I

+
+
Ivy - class fr.dgac.ivy.Ivy.
A class connecting to the Ivy software bus. +
Ivy(String, String, IvyApplicationListener) - +Constructor for class fr.dgac.ivy.Ivy +
Readies the structures for the software bus connexion. + + +
IvyApplicationAdapter - class fr.dgac.ivy.IvyApplicationAdapter.
this class is a dummy ApplicationListener
IvyApplicationAdapter() - +Constructor for class fr.dgac.ivy.IvyApplicationAdapter +
  +
IvyApplicationListener - interface fr.dgac.ivy.IvyApplicationListener.
this interface specifies the methods of an ApplicationListener
IvyClient - class fr.dgac.ivy.IvyClient.
A private Class for the the peers on the bus.
IvyException - exception fr.dgac.ivy.IvyException.
signals that an unrecoverrable Ivy exception has occured.
IvyMessageListener - interface fr.dgac.ivy.IvyMessageListener.
this interface specifies the methods of an IvyMessageListener
+
+

+P

+
+
PROCOCOLVERSION - +Static variable in class fr.dgac.ivy.Ivy +
the protocol version number +
+
+

+R

+
+
receive(IvyClient, String[]) - +Method in interface fr.dgac.ivy.IvyMessageListener +
this callback is invoked when a message has been received +
removeApplicationListener(int) - +Method in class fr.dgac.ivy.Ivy +
removes an application listener +
run() - +Method in class fr.dgac.ivy.IvyClient +
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 +
run() - +Method in class fr.dgac.ivy.Ivy +
  +
+
+

+S

+
+
sendMsg(String) - +Method in class fr.dgac.ivy.Ivy +
Performs a pattern matching according to everyone's regexps, and sends + the results to the relevant ivy agents. + +
start(String) - +Method in class fr.dgac.ivy.Ivy +
connects the Ivy bus to a domain or list of domains +
stop() - +Method in class fr.dgac.ivy.Ivy +
disconnects from the Ivy bus. + +
+
+

+U

+
+
unBindMsg(int) - +Method in class fr.dgac.ivy.Ivy +
unsubscribes a regular expression +
+
+A B C D I P R S U + + + + + + + + + + + + +
+ + + + + + + + + +
Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES
+ + +
+ + + -- cgit v1.1