Skip to content

Commit 406042f

Browse files
committed
updated README with rest
1 parent 631a612 commit 406042f

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ Each listener is autosufficient, and get called by the container (Ding) whenever
2828
interesting event occurs. Ding will get called by the pami helper, whenever AMI reports
2929
an event. This event will then get dispatched to the listeners by ding.
3030

31+
TCP Server
32+
----------
33+
AsterTrace uses the Ding TCPServerHelper to start a tcp server. This server allows you
34+
to connect and issue commands, also you can listen for events. The events and responses to
35+
the actions sent are serialized with json :) You can try it via telnet.
36+
37+
REST interface
38+
--------------
39+
Also, a rest interface is available, so you can make it publicly available through a webserver. This
40+
rest interface will let you get events from ami in a json format. Ideal for COMET/Long polling.
41+
3142
Requirements
3243
------------
3344
* PHP 5.3+
@@ -42,10 +53,12 @@ Configuration
4253
Assuming you are inside the root directory of the source (thus, having ./conf and ./src)
4354

4455
1.- Copy/Rename the file: conf/log4php.properties.example to log4php.properties. Edit it.
45-
2.- Copy/Rename the file: conf/mysql.properties.example to mysql.properties. Edit it. The only
56+
2.- Copy/Rename the file: conf/log4php.properties.example to log4php-rest.properties. Edit it.
57+
3.- Copy/Rename the file: conf/mysql.properties.example to mysql.properties. Edit it. The only
4658
thing you need from mysql, is to have the database created (nothing else, no tables,
4759
AsterTrace will create them on demand).
48-
3.- Copy/Rename the file: conf/php.properties.example to php.properties. Edit it. You can have
60+
4.- Copy/Rename the file: conf/php.properties.example to php.properties. Edit it. You can have
4961
your own php settings here.
50-
4.- Copy/Rename the file: conf/astertrace.properties.example to astertrace.properties. Edit it.
51-
5.- Run astertrace, like "php src/mg/AsterTrace/bin/astertrace.php ./conf"
62+
5.- Copy/Rename the file: conf/astertrace.properties.example to astertrace.properties. Edit it.
63+
6.- Copy/Rename the file: conf/server.properties.example to server.properties. Edit it.
64+
7.- Run astertrace, like "php src/mg/AsterTrace/bin/astertrace.php ./conf"

0 commit comments

Comments
 (0)