aboutsummaryrefslogtreecommitdiff
path: root/README
blob: e621fee9513276e2b61aa9255c1d924ff1a15422 (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
IVY - Ruby interface to IVY API
===============================

Copyright Notice
----------------

Ruby/IVY v0.1.0 

Copyright (C) 2007 Gregoire Lejeune <gregoire.lejeune@free.fr>

Ruby/IVY is freely distributable according to the terms of the
GNU Lesser General Public Licence (see the file 'COPYING').

This program is distributed without any warranty. See the file
'COPYING' for details.

About IVY
---------

IVY provides users with the ability to write Ruby programs
that tightly integrate with IVY API.

With this module, you can define and register Ruby callbacks with the IVY
engine. This module calls your ruby callbacks using interpreters from a
threaded persistent interpreter pool. IVY contexts are presented using an
object-oriented style interface for performing operations on a IVY context.

The main project web page for this module is:

    http://greg.rubyfr.net

Prerequisites
-------------

Ruby/IVY has been tested with the following:

    IVY-c-3.9.1
	PCRE-7.0
    ruby 1.8.4 built

You can find the latest version of IVY from:

    http://www.tls.cena.fr/products/ivy/

and the latest version of PCRE from :
	
	http://www.pcre.org/

This module has only been tested on MacOSX 10.4.8. It was also compiled on Linux.

Building Ruby/IVY
-----------------

Begin by building ivy-c, pcre, and ruby. Next, perform the following 
commands:

% ruby extconf.rb
% make
% make install

or if you want a rakefile instead of a makefile :

% ruby makerake.rb
% rake
% rake install

Using Ruby/IVY
--------------

See the documentation for complete information on writing your own program using IVY.

Testing the samples
-------------------

000-IVYTranslater.rb. You can run it by using the following command:

% ruby 000-IVYTranslater.rb

Then in another terminal window, launch ivyprobe ’(.*)’. You are then ready to start. Type "Hello Paul", 
and you should get "Bonjour Paul". Type "Bye", and your application should quit: 

% ivyprobe ’(.*)’ 
IvyTranslater connected from localhost 
IvyTranslater subscribes to ’Hello (.*)’ 
IvyTranslater subscribes to ’Bye’ 
Hello Paul 
IvyTranslater sent ’Bonjour Paul’ 
Bye 
IvyTranslater disconnected from localhost 
Ctrl-D 
%