Bug 56300 - [Tribes] No useful examples, lack of documentation
Summary: [Tribes] No useful examples, lack of documentation
Status: NEW
Alias: None
Product: Tomcat 7
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: PC Linux
: P2 enhancement (vote)
Target Milestone: ---
Assignee: Tomcat Developers Mailing List
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-03-22 10:46 UTC by Matthias Müller
Modified: 2014-03-30 13:45 UTC (History)
1 user (show)



Attachments
Channel test according to documentation (1.76 KB, text/x-java)
2014-03-22 10:46 UTC, Matthias Müller
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Matthias Müller 2014-03-22 10:46:38 UTC
Created attachment 31422 [details]
Channel test according to documentation

The only available documentation for tribes is
http://tomcat.apache.org/tomcat-7.0-doc/tribes/introduction.html
(where all sub pages are empty)

The provided example
1) doesn't compile
2) produces
Exception in thread "main" org.apache.catalina.tribes.ChannelException: No destination given; No faulty members identified.
	at org.apache.catalina.tribes.group.GroupChannel.send(GroupChannel.java:202)
	at org.apache.catalina.tribes.group.GroupChannel.send(GroupChannel.java:182)
	at ChannelTest.main(ChannelTest.java:54)
after making it compileable

If one wants to use tribes in a cluster environment for custom message sharing, there are no usefull examples available in the documentation.
It would be great to have some getting startet guides for common usage scenarios in using this (obviously very powerfull and performant, otherwise Tomcat would used it for internal clustering ;-) messaging framework.
Of course you could checkout the sources from SVN and browse the tests and examples provided there, but a short and accurate documentation would definitely a better source for getting started with tribes.

Regards
Matthias
Comment 1 Mark Thomas 2014-03-23 23:11:59 UTC
I've fixed the obvious bug in the example.

The errors you see are because you only have a single member in the cluster so there is nowhere to send the message to.

Patches to improve the documentation are always welcome.

You may want to take a look in the unit tests as there are some Tribes demos / samples / tests that you might want to refer to and/or adapt for use in the docs.
Comment 2 Matthias Müller 2014-03-29 08:42:14 UTC
Hi Mark,

tnx for your reply!
I was hoping that there is some (maybe internal) documentation available, which could be made public on the website.
If that's not the case, I will try to dig into the sources and testcases.
Where's the right place to submit documentation-patches to?

Regards
Matthias