| Hongqing Liu | 7189829 | 2014-10-15 13:31:32 +0800 | [diff] [blame] | 1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tribes - The Tomcat Cluster Communication Module (6.0.41) - Apache Tribes - Introduction</title><meta name="author" content="Filip Hanik"><style type="text/css" media="print">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 2 | .noPrint {display: none;}
|
| 3 | td#mainBody {width: 100%;}
|
| Hongqing Liu | 7189829 | 2014-10-15 13:31:32 +0800 | [diff] [blame] | 4 | </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="../images/tomcat.gif" align="right" alt="Apache Tomcat" border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1><font face="arial,helvetica,sanserif">Version 6.0.41, May 19 2014</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="nowrap" class="noPrint"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="faq.html">3) FAQ</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="../api/org/apache/catalina/tribes/package-summary.html">JavaDoc</a></li></ul><p><strong>Apache Tribes Development</strong></p><ul><li><a href="membership.html">Membership</a></li><li><a href="transport.html">Transport</a></li><li><a href="interceptors.html">Interceptors</a></li><li><a href="status.html">Status</a></li><li><a href="developers.html">Developers</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Apache Tribes - The Tomcat Cluster Communication Module</h1><h2>Apache Tribes - Introduction</h2><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote>
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 5 | <ul><li><a href="#Quick_Start">Quick Start</a></li><li><a href="#What_is_Tribes">What is Tribes</a></li><li><a href="#Why_another_messaging_framework">Why another messaging framework</a></li><li><a href="#Feature_Overview">Feature Overview</a></li><li><a href="#Where_can_I_get_Tribes">Where can I get Tribes</a></li></ul>
|
| 6 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Quick Start"><!--()--></a><a name="Quick_Start"><strong>Quick Start</strong></a></font></td></tr><tr><td><blockquote>
|
| 7 |
|
| 8 | <p>Apache Tribes is a group or peer-to-peer communication framework that enables you to easily connect
|
| 9 | your remote objects to communicate with each other.
|
| 10 | </p>
|
| 11 | <ul>
|
| 12 | <li>Import: <code>org.apache.catalina.tribes.Channel</code></li>
|
| 13 | <li>Import: <code>org.apache.catalina.tribes.Member</code></li>
|
| 14 | <li>Import: <code>org.apache.catalina.tribes.MembershipListener</code></li>
|
| 15 | <li>Import: <code>org.apache.catalina.tribes.ChannelListener</code></li>
|
| 16 | <li>Import: <code>org.apache.catalina.tribes.group.GroupChannel</code></li>
|
| 17 | <li>Create a class that implements: <code>org.apache.catalina.tribes.ChannelListener</code></li>
|
| 18 | <li>Create a class that implements: <code>org.apache.catalina.tribes.MembershipListener</code></li>
|
| 19 | <li>Simple class to demonstrate how to send a message:
|
| 20 | <div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
| 21 | //create a channel
|
| 22 | Channel myChannel = new GroupChannel();
|
| 23 |
|
| 24 | //create my listeners
|
| 25 | ChannelListener msgListener = new MyMessageListener();
|
| 26 | MembershipListener mbrListener = new MyMemberListener();
|
| 27 |
|
| 28 | //attach the listeners to the channel
|
| 29 | myChannel.addMembershipListener(mbrListener);
|
| 30 | myChannel.addChannelListener(msgListener);
|
| 31 |
|
| 32 | //start the channel
|
| 33 | myChannel.start(Channel.DEFAULT);
|
| 34 |
|
| 35 | //create a message to be sent, message must implement java.io.Serializable
|
| 36 | //for performance reasons you probably want them to implement java.io.Externalizable
|
| 37 | Serializable myMsg = new MyMessage();
|
| 38 |
|
| 39 | //retrieve my current members
|
| 40 | Member[] group = myChannel.getMembers();
|
| 41 |
|
| 42 | //send the message
|
| 43 | channel.send(group,myMsg,Channel.SEND_OPTIONS_DEFAULT);
|
| 44 | </pre></td><td bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
| 45 | </li>
|
| 46 | </ul>
|
| 47 | <p>
|
| 48 | Simple yeah? There is a lot more to Tribes than we have shown, hopefully the docs will be able
|
| 49 | to explain more to you. Remember, that we are always interested in suggestions, improvements, bug fixes
|
| 50 | and anything that you think would help this project.
|
| 51 | </p>
|
| 52 | <p>
|
| 53 | Note: Tribes is currently built for JDK1.5, you can run on JDK1.4 by a small modifications to locks used from the <code>java.util.concurrent</code> package.
|
| 54 | </p>
|
| 55 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="What is Tribes"><!--()--></a><a name="What_is_Tribes"><strong>What is Tribes</strong></a></font></td></tr><tr><td><blockquote>
|
| 56 | <p>
|
| 57 | Tribes is a messaging framework with group communication abilities. Tribes allows you to send and receive
|
| 58 | messages over a network, it also allows for dynamic discovery of other nodes in the network.<br>
|
| 59 | And that is the short story, it really is as simple as that. What makes Tribes useful and unique will be
|
| 60 | described in the section below.<br>
|
| 61 | </p>
|
| 62 | <p>
|
| 63 | The Tribes module was started early 2006 and a small part of the code base comes from the clustering module
|
| 64 | that has been existing since 2003 or 2004.
|
| 65 | The current cluster implementation has several short comings and many workarounds were created due
|
| 66 | to the complexity in group communication. Long story short, what should have been two modules a long time
|
| 67 | ago, will be now. Tribes takes out the complexity of messaging from the replication module and becomes
|
| 68 | a fully independent and highly flexible group communication module.<br>
|
| 69 | </p>
|
| 70 | <p>
|
| 71 | In Tomcat the old <code>modules/cluster</code> has now become <code>modules/groupcom</code>(Tribes) and
|
| 72 | <code>modules/ha</code> (replication). This will allow development to proceed and let the developers
|
| 73 | focus on the issues they are actually working on rather than getting boggled down in details of a module
|
| 74 | they are not interested in. The understanding is that both communication and replication are complex enough,
|
| 75 | and when trying to develop them in the same module, well you know, it becomes a cluster :)<br>
|
| 76 | </p>
|
| 77 | <p>
|
| 78 | Tribes allows for guaranteed messaging, and can be customized in many ways. Why is this important?<br>
|
| 79 | Well, you as a developer want to know that the messages you are sending are reaching their destination.
|
| 80 | More than that, if a message doesn't reach its destination, the application on top of Tribes will be notified
|
| 81 | that the message was never sent, and what node it failed.
|
| 82 | </p>
|
| 83 |
|
| 84 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Why another messaging framework"><!--()--></a><a name="Why_another_messaging_framework"><strong>Why another messaging framework</strong></a></font></td></tr><tr><td><blockquote>
|
| 85 | <p>
|
| 86 | I am a big fan of reusing code and would never dream of developing something if someone else has already
|
| 87 | done it and it was available to me and the community I try to serve.<br>
|
| 88 | When I did my research to improve the clustering module I was constantly faced with a few obstacles:<br>
|
| 89 | 1. The framework wasn't flexible enough<br>
|
| 90 | 2. The framework was licensed in a way that neither I nor the community could use it<br>
|
| 91 | 3. Several features that I needed were missing<br>
|
| 92 | 4. Messaging was guaranteed, but no feedback was reported to me<br>
|
| 93 | 5. The semantics of my message delivery had to be configured before runtime<br>
|
| 94 | And the list continues...
|
| 95 | </p>
|
| 96 | <p>
|
| 97 | So I came up with Tribes, to address these issues and other issues that came along.
|
| 98 | When designing Tribes I wanted to make sure I didn't lose any of the flexibility and
|
| 99 | delivery semantics that the existing frameworks already delivered. The goal was to create a framework
|
| 100 | that could do everything that the others already did, but to provide more flexibility for the application
|
| 101 | developer. In the next section will give you the high level overview of what features tribes offers or will offer.
|
| 102 | </p>
|
| 103 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Feature Overview"><!--()--></a><a name="Feature_Overview"><strong>Feature Overview</strong></a></font></td></tr><tr><td><blockquote>
|
| 104 | <p>
|
| 105 | To give you an idea of the feature set I will list it out here.
|
| 106 | Some of the features are not yet completed, if that is the case they are marked accordingly.
|
| 107 | </p>
|
| 108 | <p>
|
| 109 | <b>Pluggable modules</b><br>
|
| 110 | Tribes is built using interfaces. Any of the modules or components that are part of Tribes can be swapped out
|
| 111 | to customize your own Tribes implementation.
|
| 112 | </p>
|
| 113 | <p>
|
| 114 | <b>Guaranteed Messaging</b><br>
|
| 115 | In the default implementation of Tribes uses TCP for messaging. TCP already has guaranteed message delivery
|
| 116 | and flow control built in. I believe that the performance of Java TCP, will outperform an implementation of
|
| 117 | Java/UDP/flow-control/message guarantee since the logic happens further down the stack.<br>
|
| 118 | Tribes supports both non-blocking and blocking IO operations. The recommended setting is to use non blocking
|
| 119 | as it promotes better parallelism when sending and receiving messages. The blocking implementation is available
|
| 120 | for those platforms where NIO is still a trouble child.
|
| 121 | </p>
|
| 122 | <p>
|
| 123 | <b>Different Guarantee Levels</b><br>
|
| 124 | There are three different levels of delivery guarantee when a message is sent.<br>
|
| 125 | <ol>
|
| 126 | <li>IO Based send guarantee. - fastest, least reliable<br>
|
| 127 | This means that Tribes considers the message transfer to be successful
|
| 128 | if the message was sent to the socket send buffer and accepted.<br>
|
| 129 | On blocking IO, this would be <code>socket.getOutputStream().write(msg)</code><br>
|
| 130 | On non blocking IO, this would be <code>socketChannel.write()</code>, and the buffer byte buffer gets emptied
|
| 131 | followed by a <code>socketChannel.read()</code> to ensure the channel still open.
|
| 132 | The <code>read()</code> has been added since <code>write()</code> will succeed if the connection has been "closed"
|
| 133 | when using NIO.
|
| 134 | </li>
|
| 135 | <li>ACK based. - recommended, guaranteed delivery<br>
|
| 136 | When the message has been received on a remote node, an ACK is sent back to the sender,
|
| 137 | indicating that the message was received successfully.
|
| 138 | </li>
|
| 139 | <li>SYNC_ACK based. - guaranteed delivery, guaranteed processed, slowest<br>
|
| 140 | When the message has been received on a remote node, the node will process
|
| 141 | the message and if the message was processed successfully, an ACK is sent back to the sender
|
| 142 | indicating that the message was received and processed successfully.
|
| 143 | If the message was received, but processing it failed, an ACK_FAIL will be sent back
|
| 144 | to the sender. This is a unique feature that adds an incredible amount value to the application
|
| 145 | developer. Most frameworks here will tell you that the message was delivered, and the application
|
| 146 | developer has to build in logic on whether the message was actually processed properly by the application
|
| 147 | on the remote node. If configured, Tribes will throw an exception when it receives an ACK_FAIL
|
| 148 | and associate that exception with the member that didn't process the message.
|
| 149 | </li>
|
| 150 | </ol>
|
| 151 | You can of course write even more sophisticated guarantee levels, and some of them will be mentioned later on
|
| 152 | in the documentation. One mentionable level would be a 2-Phase-Commit, where the remote applications don't receive
|
| 153 | the message until all nodes have received the message. Sort of like a all-or-nothing protocol.
|
| 154 | </p>
|
| 155 | <p>
|
| 156 | <b>Per Message Delivery Attributes</b><br>
|
| 157 | Perhaps the feature that makes Tribes stand out from the crowd of group communication frameworks.
|
| 158 | Tribes enables you to send to decide what delivery semantics a message transfer should have on a per
|
| 159 | message basis. Meaning, that your messages are not delivered based on some static configuration
|
| 160 | that remains fixed after the message framework has been started.<br>
|
| 161 | To give you an example of how powerful this feature is, I'll try to illustrate it with a simple example.
|
| 162 | Imagine you need to send 10 different messages, you could send the the following way:
|
| 163 | <div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
| 164 | Message_1 - asynchronous and fast, no guarantee required, fire and forget
|
| 165 | Message_2 - all-or-nothing, either all receivers get it, or none.
|
| 166 | Message_3 - encrypted and SYNC_ACK based
|
| 167 | Message_4 - asynchronous, SYNC_ACK and call back when the message is processed on the remote nodes
|
| 168 | Message_5 - totally ordered, this message should be received in the same order on all nodes that have been
|
| 169 | send totally ordered
|
| 170 | Message_6 - asynchronous and totally ordered
|
| 171 | Message_7 - RPC message, send a message, wait for all remote nodes to reply before returning
|
| 172 | Message_8 - RPC message, wait for the first reply
|
| 173 | Message_9 - RPC message, asynchronous, don't wait for a reply, collect them via a callback
|
| 174 | Message_10- sent to a member that is not part of this group
|
| 175 | </pre></td><td bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
| 176 | As you can imagine by now, these are just examples. The number of different semantics you can apply on a
|
| 177 | per-message-basis is almost limitless. Tribes allows you to set up to 28 different on a message
|
| 178 | and then configure Tribes to what flag results in what action on the message.<br>
|
| 179 | Imagine a shared transactional cache, probably >90% are reads, and the dirty reads should be completely
|
| 180 | unordered and delivered as fast as possible. But transactional writes on the other hand, have to
|
| 181 | be ordered so that no cache gets corrupted. With tribes you would send the write messages totally ordered,
|
| 182 | while the read messages you simple fire to achieve highest throughput.<br>
|
| 183 | There are probably better examples on how this powerful feature can be used, so use your imagination and
|
| 184 | your experience to think of how this could benefit you in your application.
|
| 185 | </p>
|
| 186 | <p>
|
| 187 | <b>Interceptor based message processing</b><br>
|
| 188 | Tribes uses a customizable interceptor stack to process messages that are sent and received.<br>
|
| 189 | <i>So what, all frameworks have this!</i><br>
|
| 190 | Yes, but in Tribes interceptors can react to a message based on the per-message-attributes
|
| 191 | that are sent runtime. Meaning, that if you add a encryption interceptor that encrypts message
|
| 192 | you can decide if this interceptor will encrypt all messages, or only certain messages that are decided
|
| 193 | by the applications running on top of Tribes.<br>
|
| 194 | This is how Tribes is able to send some messages totally ordered and others fire and forget style
|
| 195 | like the example above.<br>
|
| 196 | The number of interceptors that are available will keep growing, and we would appreciate any contributions
|
| 197 | that you might have.
|
| 198 | </p>
|
| 199 | <p>
|
| 200 | <b>Threadless Interceptor stack</b>
|
| 201 | The interceptor don't require any separate threads to perform their message manipulation.<br>
|
| 202 | Messages that are sent will piggy back on the thread that is sending them all the way through transmission.
|
| 203 | The exception is the <code>MessageDispatchInterceptor</code> that will queue up the message
|
| 204 | and send it on a separate thread for asynchronous message delivery.
|
| 205 | Messages received are controlled by a thread pool in the <code>receiver</code> component.<br>
|
| 206 | The channel object can send a <code>heartbeat()</code> through the interceptor stack to allow
|
| 207 | for timeouts, cleanup and other events.<br>
|
| 208 | The <code>MessageDispatchInterceptor</code> is the only interceptor that is configured by default.
|
| 209 | </p>
|
| 210 | <p>
|
| 211 | <b>Parallel Delivery</b><br>
|
| 212 | Tribes support parallel delivery of messages. Meaning that node_A could send three messages to node_B in
|
| 213 | parallel. This feature becomes useful when sending messages with different delivery semantics.
|
| 214 | Otherwise if Message_1 was sent totally ordered, Message_2 would have to wait for that message to complete.<br>
|
| 215 | Through NIO, Tribes is also able to send a message to several receivers at the same time on the same thread.
|
| 216 | </p>
|
| 217 | <p>
|
| 218 | <b>Silent Member Messaging</b><br>
|
| 219 | With Tribes you are able to send messages to members that are not in your group.
|
| 220 | So by default, you can already send messages over a wide area network, even though the dynamic discover
|
| 221 | module today is limited to local area networks by using multicast for dynamic node discovery.
|
| 222 | Of course, the membership component will be expanded to support WAN memberships in the future.
|
| 223 | But this is very useful, when you want to hide members from the rest of the group and only communicate with them
|
| 224 | </p>
|
| 225 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Where can I get Tribes"><!--()--></a><a name="Where_can_I_get_Tribes"><strong>Where can I get Tribes</strong></a></font></td></tr><tr><td><blockquote>
|
| 226 | <p>
|
| 227 | Tribes ships as a module with Tomcat, and is released as part of the Apache Tomcat release.
|
| 228 | </p>
|
| 229 |
|
| 230 |
|
| 231 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
|
| 232 | Copyright © 1999-2014, Apache Software Foundation
|
| 233 | </em></font></div></td></tr></table></body></html> |