From 7cfa818995332e8b54fc1831bacdf9c2d131155c Mon Sep 17 00:00:00 2001 From: jacomi Date: Wed, 17 Mar 1999 19:11:36 +0000 Subject: first draft for man pages on ivy-c --- doc/ivy-c.1 | 244 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ivy-c.htm | 228 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ivyprobe.1 | 16 ++++ 3 files changed, 488 insertions(+) create mode 100644 doc/ivy-c.1 create mode 100644 doc/ivy-c.htm create mode 100644 doc/ivyprobe.1 (limited to 'doc') diff --git a/doc/ivy-c.1 b/doc/ivy-c.1 new file mode 100644 index 0000000..00472e2 --- /dev/null +++ b/doc/ivy-c.1 @@ -0,0 +1,244 @@ +'\" +'\" Ivy, C interface \- library managing connexions to a software bus +'\" +'\" Copyright (C) 1997-1999 +'\" Centre d'Études de la Navigation Aérienne +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" +'\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ie !"\\$3"" \{\ +.ta \\n()Au \\n()Bu +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +'\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +'\" # BS - start boxed text +'\" # ^y = starting y location +'\" # ^b = 1 +.TH Ivy-c 1 3.0 "Ivy-c 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, +IvyXtChannelAppContext, +.SH SYNOPSIS +useful library functions for communicating through a sofware bus +.nf +.sp +\fBIvyInit(\fIAppName, ready, callback, data, die_callback, die_data\fB)\fR +.sp +void +\fBIvyStart(\fIbus\fB)\fR +.sp +void +\fBIvyStop()\fR +.sp +MsgRcvPtr +\fBIvyBindMsg(\fIcallback, user_data, regexp, ...\fB)\fR +.sp +void +\fBIvyUnbindMsg(\fIid\fB)\fR +.sp +void +\fBIvyBindDirectMsg(\fIcallback, user_data\fB)\fR +.sp +int +\fBIvySendMsg(\fIfmt_message, ...\fB)\fR +.sp +void +\fBIvySendDirectMsg(\fIapp, id, msg\fB)\fR +.sp +void +\fBIvySendDieMsg(\fIapp\fB)\fR +.sp +void +\fBIvySendError(\fIapp, id, fmt, ...\fB)\fR +.sp +char* +\fBIvyGetApplicationName(\fIapp\fB)\fR +.sp +char* +\fBIvyGetApplicationHost(\fIapp\fB)\fR +.sp +char* +\fBIvyGetApplication(\fIname\fB)\fR +.sp +char* +\fBIvyGetApplicationList()\fR +.sp +char** +\fBIvyGetApplicationMessages(\fapp\fB)\fR +.sp +char* +\fBIvyDefaultApplicationCallback(\fIapp, user_data, Event\fB)\fR +char* +\fBIvyClasses(\fIargc, argv\fB)\fR +.sp +void +\fBIvyChannelInit(\fIvoid\fB)\fR +.sp +Channel +\fBIvyChannelSetUp(\fIfd, data, handle_delete, handle_read\fB)\fR +.sp +void +\fBIvyMainLoop(\fIhook\fB)\fR +.sp +void +\fBIvyChannelClose(\fIchannel\fB)\fR +.sp +static void +\fBIvyChannelDelete(\fIchannel\fB)\fR +.sp +static void +\fBIvyChannelHandleRead(\fIcurrent\fB)\fR +.sp +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 +.SH ARGUMENTS +.SH +\fBIvyInit\fR: +Initialisation of a connection +.sp +.AS "MaxSize" die_callback +.AP const_char *AppName in +Application Name +.AP const_char *ready in +Ready Message (can be NULL) +.AP IvyApplicationCallback callback in +Callback to be called on a connexion/deconnexion of an application +.AP void *data in +user data +.AP IvyDieCallback die_callback in +last change callback before die +.AP void *die_data in +user data +.SH +\fBIvyStart\fR: +Initialisation of TCP/UPD port and sending of a broadcast handshake on every network +.AP const_char *bus in +Bus (format : network list followed by broadcast port) example : +123.231,123.123:2000 or 123.231 or :2000 +If no argument specified, check the environment variable \fBIVYBUS\fR, +else use the default value : 127.255.255.255:2010 +.SH +\fBIvyBindMsg\fR: +Message binding +.AP MsgCallback callback in +.AP void *user_data in +.AP const_char *regexp in +.AP MsgRcvPtr id out +.SH +\fBIvyUnbindMsg\fR: +Message unbinding +.AP MsgRcvPtr id in +.SH +\fBIvyChannelSetUp\fR: + +.AP HANDLE fd in +.AP void *data in +.AP ChannelHandleDelete handle_delete in +.AP ChannelHandleRead handle_read in +.AP Channel out out +.VE +.BE +.SH DESCRIPTION +.PP +These procedures provide facilities for connecting applications on a +software bus and managing messages exchanges among them. + +.SH EXAMPLES +Simple C code: +.nf + +.DS + +#include "ivyloop.h" +#include "ivysocket.h" +#include "ivy.h" + + int main (int argc, char* argv[]){ + IvyInit ("IVYPROBE", + bport, + "IVYPROBE READY", + ApplicationCallback, + NULL, + NULL, + NULL) + IvyChannelSetUp(0, NULL, NULL, HandleStdin); + IvyStart (domains); + IvyMainLoop(0) +}; +.DE + +.SH FILES +.I /usr/include/ivy.h +.I /usr/include/ivyloop.h +.I /usr/include/ivysocket.h +.SH ENVIRONMENT +.I IVYDOMAINS +.I IVYBUS +.SH DIAGNOSTICS +error messages displayed +.SH BUGS +none ! +.SH AUTHORS +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 +.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 + diff --git a/doc/ivy-c.htm b/doc/ivy-c.htm new file mode 100644 index 0000000..5521560 --- /dev/null +++ b/doc/ivy-c.htm @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + +

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, +IvyXtChannelAppContext, +

SYNOPSIS

+useful library functions for communicating through a sofware bus +
+

+IvyInit(AppName, ready, callback, data, die_callback, die_data) +

+void +IvyStart(bus) +

+void +IvyStop() +

+MsgRcvPtr +IvyBindMsg(callback, user_data, regexp, ...) +

+void +IvyUnbindMsg(id) +

+void +IvyBindDirectMsg(callback, user_data) +

+int +IvySendMsg(fmt_message, ...) +

+void +IvySendDirectMsg(app, id, msg) +

+void +IvySendDieMsg(app) +

+void +IvySendError(app, id, fmt, ...) +

+char* +IvyGetApplicationName(app) +

+char* +IvyGetApplicationHost(app) +

+char* +IvyGetApplication(name) +

+char* +IvyGetApplicationList() +

+char** +IvyGetApplicationMessages(\fapp) +

+char* +IvyDefaultApplicationCallback(app, user_data, Event) +char* +IvyClasses(argc, argv) +

+void +IvyChannelInit(void) +

+Channel +IvyChannelSetUp(fd, data, handle_delete, handle_read) +

+void +IvyMainLoop(hook) +

+void +IvyChannelClose(channel) +

+static void +IvyChannelDelete(channel) +

+static void +IvyChannelHandleRead(current) +

+static void +IvyChannelHandleExcpt(current) +

+static void +IvyXtChannelInit(void) +

+static void +IvyXtChannelSetUp(fd, data, handle_delete, handle_read) +

+void +IvyXtChannelClose(channel) +

+static void +IvyXtHandleChannelRead(closure, source, id) +

+static void +IvyXtHandleChannelDelete(closure, source, id) +

+void +IvyChannelAppContext(cntx) +

ARGUMENTS

+

+IvyInit: +Initialisation of a connection +

+

+
const_char *AppName +(in)
Application Name +
const_char *ready +(in)
Ready Message (can be NULL) +
IvyApplicationCallback callback +(in)
Callback to be called on a connexion/deconnexion of an application +
void *data +(in)
user data +
IvyDieCallback die_callback +(in)
last change callback before die +
void *die_data +(in)
user data +
+

+IvyStart: +Initialisation of TCP/UPD port and sending of a broadcast handshake on every network +
+
const_char *bus +(in)
Bus (format : network list followed by broadcast port) example : +123.231,123.123:2000 or 123.231 or :2000 +If no argument specified, check the environment variable IVYBUS, +else use the default value : 127.255.255.255:2010 +
+

+IvyBindMsg: +Message binding +
+
MsgCallback callback +(in)
void *user_data +(in)
const_char *regexp +(in)
MsgRcvPtr id +(out)
+

+IvyUnbindMsg: +Message unbinding +
+
MsgRcvPtr id +(in)
+

+IvyChannelSetUp: + +
+
HANDLE fd +(in)
void *data +(in)
ChannelHandleDelete handle_delete +(in)
ChannelHandleRead handle_read +(in)
Channel out +(out)
+
+
+

DESCRIPTION

+

+These procedures provide facilities for connecting applications on a +software bus and managing messages exchanges among them. + +

EXAMPLES

+Simple C code: +
+ +
+
+
+#include "ivyloop.h"
+#include "ivysocket.h"
+#include "ivy.h"
+
+ int main (int argc, char* argv[]){
+	IvyInit ("IVYPROBE",
+		 bport,
+		 "IVYPROBE READY",
+		 ApplicationCallback,
+		 NULL,
+		 NULL,
+		 NULL)
+	IvyChannelSetUp(0, NULL, NULL, HandleStdin);
+	IvyStart (domains);
+	IvyMainLoop(0)
+};
+

+
+ +

FILES

+/usr/include/ivy.h +/usr/include/ivyloop.h +/usr/include/ivysocket.h +

ENVIRONMENT

+IVYDOMAINS +IVYBUS +

DIAGNOSTICS

+error messages displayed +

BUGS

+none ! +

AUTHORS

+Francois-Regis Colin <fcolin@cenatoulouse.dgac.fr> +Stephane Chatty <chatty@cenatoulouse.dgac.fr> +

SEE ALSO

+ivyprobe (1) +

+For further details, please refer to the Ivy html page at http://www.cenatls.cena.dgac.fr/pii/produits/Ivy.html +

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 + + + diff --git a/doc/ivyprobe.1 b/doc/ivyprobe.1 new file mode 100644 index 0000000..0f7541f --- /dev/null +++ b/doc/ivyprobe.1 @@ -0,0 +1,16 @@ +.TH IVYPROBE 1 1/29/99 +.SH NAME +ivyprobe, simple program for probing connections on a given port number for ivy software bus +.SH SYNOPSIS +.B ivyprobe [options] [regexp...] +.SH DESCRIPTION +ivyprobe gives the list of applications connected to a given bus port number, receives messages subscribed to (regexp format), and sends messages on the bus. +.SH OPTIONS +.TP +.I "\-b PORT-NUMBER(1-32000)(not 2049)" +The default port number is 2010. +.TP +.I "\-domain NETWORK-ADDRESS" +The default network address is 127.255.255.255 +H SEE ALSO +.IR ivy-c (1) -- cgit v1.1