summaryrefslogtreecommitdiff
path: root/examples/chat/README
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@fastmq.commkdir>2009-12-08 21:48:39 +0100
committerMartin Sustrik <sustrik@fastmq.commkdir>2009-12-08 21:48:39 +0100
commitc98e29fb6e017a667452cd0a50536da691600353 (patch)
treebcf1f7282b16dbe1ebfad08747042fb8e62e97e1 /examples/chat/README
parent902d4f2282f4ed59f942be6fa1013b20dd964536 (diff)
README added to chat example
Diffstat (limited to 'examples/chat/README')
-rw-r--r--examples/chat/README42
1 files changed, 42 insertions, 0 deletions
diff --git a/examples/chat/README b/examples/chat/README
new file mode 100644
index 0000000..bb64d60
--- /dev/null
+++ b/examples/chat/README
@@ -0,0 +1,42 @@
+
+This example is a simple instant messaging implementation. There are multiple
+partipants in the chat, both sending and reading messages. The sending
+application 'prompt' is separated from the application displayinf the chat
+'display' so that there's no need for sophisticated GUI.
+
+To run the example you'll need both applications plus the 'forwarder' device
+that will play role of messaging server (chatroom). Build it this way:
+
+$ ./autogen.sh
+$ ./configure --with-chat --with-forwarder
+$ make
+$ sudo make install
+
+Once it is build create the configuration file (say config.xml) for the
+forwarder describing which network endpoints are to be used for incoming and
+outgoing messages:
+
+<forwarder>
+ <in>
+ <bind addr = "tcp://eth0:5555"/>
+ </in>
+ <out>
+ <bind addr = "tcp://eth0:5556"/>
+ </out>
+</forwarder>
+
+You are of course free to define mutliple endpoints for either incoming or
+outgoing messages.
+
+Now start the forwarder:
+
+$ zmq_forwarder ./config.xml
+
+At this point the messaging server is ready to accept connections from
+messaging clients. When starting the sending application, specify your name
+so that messages can be attributed to you:
+
+$ ./prompt tcp://myserver:5555 "John Doe"
+
+$ ./display tcp://myserver:5556
+