mise a jour doc version 3.9

3 files changed, 49 insertions, 57 deletions

diff --git a/doc/ivy-c-functions.1 b/doc/ivy-c-functions.1
index 4912340..9c20ad4 100644
--- a/doc/ivy-c-functions.1
+++ b/doc/ivy-c-functions.1
@@ -1,7 +1,7 @@
 '\"
 '\" Ivy, C interface \- library managing connexions to a software bus
 '\"
-'\" Copyright (C) 1997-1999
+'\" Copyright (C) 1997-2006
 '\" Centre d'Études de la Navigation Aérienne
 '\"
 '\" See the file "license.terms" for information on usage and redistribution
@@ -42,16 +42,15 @@
 '\"	# BS - start boxed text
 '\"	# ^y = starting y location
 '\"	# ^b = 1
-.TH Ivy-c-3.0 1 3.0  "Ivy-c-3.0 Library Functions"
+.TH Ivy-c-3.9 1 3.9  "Ivy-c-3.9 Library Functions"
 .SH NAME
 IvyInit, IvyStart, IvyStop, IvyBindMsg, IvyUnbindMsg, IvyBindDirectMsg,
 IvySendMsg, IvySendDirectMsg, IvySendDieMsg, IvySendError, IvyGetApplicationName,
 IvyGetApplicationHost, IvyGetApplication, IvyGetApplicationList,
-IvyGetApplicationMessages, IvyDefaultApplicationCallback, IvyClasses,
-IvyChannelInit, IvyChannelSetUp, IvyMainLoop, IvyChannelClose,
-IvyChannelDelete, IvyChannelHandleRead,
-IvyChannelHandleExcpt,  IvyXtChannelInit, IvyXtChannelSetUp
-IvyXtChannelClose, IvyXtHandleChannelRead, IvyXtHandleChannelDelete,
+IvyGetApplicationMessages, IvyDefaultApplicationCallback, IvySetFilter, IvySetBindCallback,
+IvyChannelInit, IvyChannelStop, IvyChannelAdd, IvyChannelRemove, IvyMainLoop,
+IvyChannelDelete, IvyChannelHandleRead, IvyChannelHandleExcpt,
+IvySetBeforeSelectHook, IvySetAfterSelectHook,
 IvyXtChannelAppContext, 
 .SH SYNOPSIS
 useful set of library functions for communicating between different
@@ -105,22 +104,19 @@ char**
 char*
 \fBIvyDefaultApplicationCallback(\fIapp, user_data, Event\fB)\fR
 char*
-\fBIvyClasses(\fIargc, argv\fB)\fR
+\fBIvySetFilter(\fIargc, argv\fB)\fR
 .sp
 void
 \fBIvyChannelInit(\fIvoid\fB)\fR
 .sp
 Channel
-\fBIvyChannelSetUp(\fIfd, data, handle_delete, handle_read\fB)\fR
+\fBIvyChannelAdd(\fIfd, data, handle_delete, handle_read\fB)\fR
 .sp
 void
-\fBIvyMainLoop(\fIhook\fB)\fR
+\fBIvyChannelRemove(\fIchannel\fB)\fR
 .sp
 void
-\fBIvyChannelClose(\fIchannel\fB)\fR
-.sp
-static void
-\fBIvyChannelDelete(\fIchannel\fB)\fR
+\fBIvyMainLoop()\fR
 .sp
 static void
 \fBIvyChannelHandleRead(\fIcurrent\fB)\fR
@@ -128,23 +124,8 @@ static void
 static void
 \fBIvyChannelHandleExcpt(\fIcurrent\fB)\fR
 .sp
-static void
-\fBIvyXtChannelInit(\fIvoid\fB)\fR
-.sp
-static void
-\fBIvyXtChannelSetUp(\fIfd, data, handle_delete, handle_read\fB)\fR
-.sp
-void
-\fBIvyXtChannelClose(\fIchannel\fB)\fR
-.sp
-static void
-\fBIvyXtHandleChannelRead(\fIclosure, source, id\fB)\fR
-.sp
-static void
-\fBIvyXtHandleChannelDelete(\fIclosure, source, id\fB)\fR
-.sp
 void
-\fBIvyChannelAppContext(\fIcntx\fB)\fR
+\fBIvyXtChannelAppContext(\fIcntx\fB)\fR
 .SH ARGUMENTS
 Only main functions are detailed in this section
 .SH
@@ -204,14 +185,14 @@ String to be sent on the bus
 .SH Example:
 \fBIvySendMsg ("SECTOR:%s.AIRCRAFT:%s Entered", sectorname, pln->indicatif);\fR
 .SH
-\fBIvyChannelSetUp\fR:
+\fBIvyChannelAdd\fR:
 .AP HANDLE fd in
 .AP void *data in
 .AP ChannelHandleDelete handle_delete in
 .AP ChannelHandleRead handle_read in
 .AP Channel out out
 .SH Example:
-\fBIvyChannelSetUp (0, NULL, NULL, HandleStdin);\fR:
+\fBIvyChannelAdd (0, NULL, NULL, HandleStdin);\fR:
 .VE 
 .BE
 .SH DESCRIPTION
@@ -245,11 +226,11 @@ Connection of the application \fBIVYPROBE\fR on a given bus
 		 NULL,
 		 NULL);
 /* keyboard's inputs management */
-	IvyChannelSetUp(0, NULL, NULL, HandleStdin);
+	IvyChannelAdd(0, NULL, NULL, HandleStdin);
 /* starting the connection */
 	IvyStart (bus);
 /* Main loop */
-	IvyMainLoop(0);
+	IvyMainLoop();
 };
 .DE
 
@@ -268,13 +249,13 @@ error messages displayed
 .SH BUGS
 none reported yet!
 .SH AUTHORS
-Francois-Regis Colin <fcolin@cenatoulouse.dgac.fr>
-Stephane Chatty <chatty@cenatoulouse.dgac.fr>
+Francois-Regis Colin
+Stephane Chatty
 .SH SEE ALSO
 ivyprobe (1)
 .sp
-For further details, please refer to the Ivy html page at http://www.cenatls.cena.dgac.fr/pii/produits/Ivy.html
+For further details, please refer to the Ivy html page at http://www.tls.cena.fr/pii/produits/Ivy.html
 .SH NOTES
 In case of any comment or bug report on this library, please contact
-fcolin@cenatoulouse.dgac.fr, chatty@cenatoulouse.dgac.fr, jacomi@cenatoulouse.dgac.fr
+ivy@tls.cena.fr
 
diff --git a/doc/ivy-c.1 b/doc/ivy-c.1
index 14aed08..c67e96e 100644
--- a/doc/ivy-c.1
+++ b/doc/ivy-c.1
@@ -42,7 +42,7 @@
 '\"	# BS - start boxed text
 '\"	# ^y = starting y location
 '\"	# ^b = 1
-.TH Ivy-c-3.0 1 3.0  "Ivy-c-3.0 Interface"
+.TH Ivy-c-3.9 1 3.9  "Ivy-c-3.9 Interface"
 .SH NAME
 ivy-c - a software bus library
 .SH SYNOPSIS
@@ -82,15 +82,15 @@ error messages displayed
 none reported yet!
 .SH AUTHORS
 .nf
-Francois-Regis Colin <fcolin@cenatoulouse.dgac.fr>
+Francois-Regis Colin
 .nf
-Stephane Chatty <chatty@cenatoulouse.dgac.fr>
+Stephane Chatty
 .SH SEE ALSO
 ivyprobe (1)
 ivy-c-functions (1)
 .sp
-For further details, please refer to the Ivy html page at http://www.cenatls.cena.dgac.fr/pii/produits/Ivy.html
+For further details, please refer to the Ivy html page at http:// www.tls.cena.fr/pii/produits/Ivy.html
 .SH NOTES
 In case of any comment or bug report on this library, please contact
-fcolin@cenatoulouse.dgac.fr, chatty@cenatoulouse.dgac.fr, jacomi@cenatoulouse.dgac.fr
+ivy@tls.cena.fr
 
diff --git a/doc/ivy-c.sgml b/doc/ivy-c.sgml
index 7365746..0021035 100644
--- a/doc/ivy-c.sgml
+++ b/doc/ivy-c.sgml
@@ -416,9 +416,9 @@ another library.
 <title>Channels</title>
 <para>
 You can get a channel to be managed from the Ivy main loop by using functions
-<function>IvyChannelSetUp</function> and <function>IvyChannelClose</function>.
+<function>IvyChannelAdd</function> and <function>IvyChannelRemove</function>.
 <programlisting>
-Channel IvyChannelSetUp (HANDLE fd,
+Channel IvyChannelAdd (HANDLE fd,
 			void* data,
 			ChannelHandleDelete handle_delete,
 			ChannelHandleRead handle_read);
@@ -428,7 +428,7 @@ descriptor <parameter>fd</parameter>, and function <parameter>handle_delete</par
 closed, and
 
 <programlisting>
-void IvyChannelClose (Channel ch);
+void IvyChannelRemove (Channel ch);
 </programlisting>
 terminates the management of channel <parameter>ch</parameter>.
 </para>
@@ -529,7 +529,7 @@ following ones:
   <listitem><para>IvyXtChannelAppContect(app_context) with an existing Xt
   context</para>
   <listitem><para>You can add channels to be handled by Ivy, for instance,
-  stdin, with the IvyXtChannelSetUp function
+  stdin, with the IvyChannelAdd function
   <listitem><para>IvyInit(char *name,char *readyMessage,IvyApplicationCallback
   cb,void *cbUserData,IvyDieCallback dieCb,void *dieCbUserdata)</para>
   <listitem><para>IvyBindMsg() for the behavior</para>
@@ -683,18 +683,21 @@ int main( int   argc, char *argv[] ) {
 <title>Functions to be provided</title>
 <para>
 You can decide to use the main loop from another toolkit than the X Toolkit
-or the Tk toolkit. If you do that, you'll have to define three functions that
-Ivy will use to get its own channels managed by the other toolkit. The three
-following global variables should be defined:
+or the Tk toolkit. If you do that, you'll have to define four functions that
+Ivy will use to get its own channels managed by the other toolkit.
+you should link ivy with your new module insted of the ivy(xxx)loop module.
+These functions are declared in ivychannel.h:
 <programlisting>
-ChannelInit channel_init;
-ChannelSetUp channel_setup;
-ChannelClose channel_close;
+IvyChannelInit
+IvyChannelStop
+IvyChannelAdd
+IvyChannelRemove
 </programlisting>
 
 They should point to functions that respectively:
 <itemizedlist>
 <listitem><para> make the necessary global initializations before entering the main loop</para>
+<listitem><para> make the necessary global finalizations before exiting the main loop</para>
 <listitem><para> initialize a channel and ensure that it is managed by the main loop</para>
 <listitem><para> close a channel</para>
 </itemizedlist>
@@ -704,13 +707,21 @@ The types <type>ChannelInit</type>, <type>ChannelSetUp</type> and <type>ChannelC
 as follows:
 
 <programlisting>
-typedef void (*ChannelInit)(void);
-typedef Channel (*ChannelSetUp)(
+extern void IvyChannelInit(void);
+
+extern void IvyChannelStop (void);
+
+/* function called by Ivy to set callback on the sockets */
+extern Channel IvyChannelAdd(
         HANDLE fd,
         void *data,
         ChannelHandleDelete handle_delete,
-        ChannelHandleRead handle_read);
-typedef void (*ChannelClose)( Channel channel );
+        ChannelHandleRead handle_read
+);
+
+/* function called by Ivy to remove callback on the sockets */
+extern void IvyChannelRemove( Channel channel );
+
 </programlisting>
 </para>
 </sect3>