aboutsummaryrefslogtreecommitdiff
path: root/doc/ivy-java.1
blob: c5192384ec5ca712ac06dccc45bc582288bd51cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
.\" '\"
.\" '\" Ivy, Java 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.
.\" '\" 
.\" '\" 
.TH "Ivy-java" "" "" "Yannick Jestin" ""
.SH "NAME"
ivy\-java \- a software bus library java implementation
.SH "SYNOPSIS"
Ivy\-java provides a useful set of Java library classes for communicating between different
processes through a software bus
.SH "DESCRIPTION"
Ivy is a software bus, ie a system that allows any software component to freely
 exchange data.

The basic principle of a software bus is to ease the rapid implementation of new
agents, and to manage a dynamic collection of agents on the bus: agents connect,
send and receive messages, and disconnect without perturbing the overall
functionnality of the bus.

Each time an application initializes a connection on the bus, a "ready" message
is sent to all other applications already connected, and the list of the messages
subscribed by this application is dispatched.The format for the messages is free.

.nf 
The essential classes of Ivy Java are:
.nf 
.I Ivy: 
\ API for the connexion to the software bus
.nf 
.I IvyApplicationListener: 
\ contains 4 virtual methods for handling connexion/deconnexion,
die and direct messages
.nf 
.I IvyApplicationAdapter: 
\ to implement the IvyApplicationListener methods
.nf 
.I Probe: 
\ to test the regular expressions in a terminal
.nf 
.I IvyDaemon:
\ a daemon to access the bus via a simple socket: you connect (default port :
3456 ), write a msg, and exit, the daemon will send the message. This is
useful in shell scripts, in cunjunction with netcat ( echo "coucou" | nc \-q 0
localhost 3456 )

.SH "ENVIRONMENT"
.I the IVYBUS property can be given via the \-DIVYBUS=xxx.yyy.zzz:port command line 
argument. It can be a list of addresses followed by a port number. The default is a
datagram local address on a non priviledged port 127.255.255.255:2010 , it can also be
 shortened to 127:2010.  You can specify other datagram adresses with respect to your
local configuration (see ifconfig(1) ), and you can specify a multicast
address 228.5.6.7:8910 for instance. You can supply multiple domains, separated by colons

.I the IVYBUS shell variable is not used, since the policy of the JDK has
changed on this point since 1.3 . You can still use it on a previous JDK.

.nf 
.SH "FILES"
.I /usr/share/java/repository/fr/dgac/ivy/*.class
.nf 
.I /usr/share/doc/ivy\-java/

.SH "EXAMPLES"
.nf 
java \-DIVYBUS=143.196.53.255:2011 fr.dgac.ivy.Probe -help
.nf 
java \-DIVYBUS=127.0.0.1:3042,10.192.36:2021,228.5.6.7:54321 fr.dgac.ivy.Probe '^coucou (.*)'
.nf 
java fr.dgac.ivy.Probe \-b 10.192.36:2021 '^coucou (.*)'

.SH "NEEDED LIBRARIES"
.I jdk 1.1, 1.2, 1.3 or 1.4 
.nf 
.I libgnu\-regexp\-java version 1.1.3
.nf 
.I libgnu\-getopt\-java version 1.0.9
.nf 
.I If you want to run the TestIvySwing example with a 1.1 VM, you will need a swing jar

.SH "BUGS"
So far, there are problems with old java VMs ( 1.1.7A )

.SH "AUTHORS"
.nf 
Yannick Jestin <jestin@cena.fr>
.nf 
initially: Francois\-Regis Colin <fcolin@cena.fr>
.SH "SEE ALSO"
ivy\-c (1)
.nf 
ivy\-perl (1)
.nf 
ivy\-c\-functions (1)
.nf 
ivyprobe (1)
.sp
For further details, please refer to the Ivy html page at http://www.tls.cena.fr/products/ivy/

.SH "NOTES"
In case of any comment or bug report on this library, please contact jestin@cena.fr
.nf 
Special thanks to Michelle Jacomi (jacomi@cena.fr) for her kind support