Package org.apache.catalina.tribes
QuickStart
//create a channel
Channel myChannel = new GroupChannel();
//create my listeners
MyMessageListener msgListener = new MyMessageListener();
MyMemberListener mbrListener = new MyMemberListener();
//attach the listeners to the channel
myChannel.addMembershipListener(mbrListener);
myChannel.addChannelListener(msgListener);
//start the channel
myChannel.start(Channel.DEFAULT);
//create a message to be sent, message must implement java.io.Serializable
//for performance reasons you probably want them to implement java.io.Externalizable
Serializable myMsg = new MyMessage();
//retrieve my current members
Member[] group = myChannel.getMembers();
//send the message
channel.send(group,myMsg,Channel.SEND_OPTIONS_DEFAULT);
Interfaces for the Application Developer
org.apache.catalina.tribes.ChannelMain component to interact with to send messagesorg.apache.catalina.tribes.MembershipListenerListen to membership changesorg.apache.catalina.tribes.ChannelListenerListen to data messagesorg.apache.catalina.tribes.MemberIdentifies a node, implementation specific, default is org.apache.catalina.tribes.membership.MemberImpl
Interfaces for the Tribes Component Developer
org.apache.catalina.tribes.ChannelMain component to that the application interacts withorg.apache.catalina.tribes.ChannelReceiverIO Component to receive messages over some network transportorg.apache.catalina.tribes.ChannelSenderIO Component to send messages over some network transportorg.apache.catalina.tribes.MembershipServiceIO Component that handles membership discovery andorg.apache.catalina.tribes.ChannelInterceptorinterceptors between the Channel and the IO layerorg.apache.catalina.tribes.ChannelMessageThe message that is sent through the interceptor stack down to the IO layerorg.apache.catalina.tribes.MemberIdentifies a node, implementation specific to the underlying IO logic
-
Interface Summary Interface Description Channel Channel interface
A channel is a representation of a group of nodes all participating in some sort of communication with each other.
The channel is the main API class for Tribes, this is essentially the only class that an application needs to be aware of.ChannelInterceptor A ChannelInterceptor is an interceptor that intercepts messages and membership messages in the channel stack.ChannelInterceptor.InterceptorEvent ChannelListener An interface to listens to incoming messages from a channel.ChannelMessage Message that is passed through the interceptor stack after the data serialized in the Channel object and then passed down to the interceptor and eventually down to the ChannelSender componentChannelReceiver ChannelReceiver Interface
TheChannelReceiverinterface is the data receiver component at the bottom layer, the IO layer (for layers see the javadoc for theChannelinterface).ChannelSender ChannelReceiver Interface
TheChannelSenderinterface is the data sender component at the bottom layer, the IO layer (for layers see the javadoc for theChannelinterface).
The channel sender must support "silent" members, ie, be able to send a message to a member that is not in the membership, but is part of the destination parameterErrorHandler TheErrorHandlerclass is used when sending messages that are sent asynchronously and the application still needs to get confirmation when the message was sent successfully or when a message errored out.Heartbeat Can be implemented by the ChannelListener and Membership listeners to receive heartbeat notifications from the ChannelJmxChannel ManagedChannel Channel interface A managed channel interface gives you access to the components of the channels such as senders, receivers, interceptors etc for configurations purposesMember The Member interface, defines a member in the group.MembershipListener The MembershipListener interface is used as a callback to the membership service.MembershipProvider MembershipService MembershipService Interface
TheMembershipServiceinterface is the membership component at the bottom layer, the IO layer (for layers see the javadoc for theChannelinterface).MessageListener The listener to be registered with the ChannelReceiver, internal Tribes component. -
Class Summary Class Description ByteMessage A byte message is not serialized and deserialized by the channel instead it is sent as a byte array
By default Tribes uses java serialization when it receives an object to be sent over the wire.ChannelException.FaultyMember Represent a failure to a specific member when a message was sent to more than one memberUniqueId Represents a globally unique Id. -
Exception Summary Exception Description ChannelException A channel exception is thrown when an internal error happens somewhere in the channel.RemoteProcessException Message thrown by a sender when USE_SYNC_ACK receives a FAIL_ACK_COMMAND.