| org.jgroups |
|
Provides top-level public JGroups classes such as Channel, Message, etc.
|
| Java Source File Name | Type | Comment |
| Address.java | Interface | Abstract address. |
| BlockEvent.java | Class | Trivial object that represents a block event. |
| Channel.java | Class | A channel represents a group communication endpoint (like BSD datagram sockets). |
| ChannelClosedException.java | Class | Thrown if an operation is attemped on a closed channel. |
| ChannelException.java | Class | This class represents the super class for all exception types thrown by
JGroups. |
| ChannelFactory.java | Interface | A channel factory takes care of creation of channel implementations. |
| ChannelListener.java | Interface | Allows a listener to be notified when important channel events occur. |
| ChannelNotConnectedException.java | Class | Thrown if an operation is attemped on an unconnected channel. |
| Event.java | Class | Used for inter-stack and intra-stack communication. |
| ExitEvent.java | Class | Trivial object that represents an exit event. |
| ExtendedMembershipListener.java | Interface | |
| ExtendedMessageListener.java | Interface | ExtendedMessageListener has additional callbacks for:
- partial state transfer - http://jira.jboss.com/jira/browse/JGRP-118
- streaming state transfer - http://jira.jboss.com/jira/browse/JGRP-89
Application channels interested in using streaming state transfer, beside
implementing this interface, have to be configured with
STREAMING_STATE_TRANSFER protocol rather than the default
STATE_TRANSFER protocol. |
| ExtendedReceiver.java | Interface | Extends Receiver, plus the partial state transfer methods. |
| ExtendedReceiverAdapter.java | Class | |
| GetStateEvent.java | Class | Represents a GetState event. |
| Global.java | Class | Globals used by JGroups packages. |
| Header.java | Class | Abstract base class for all headers to be added to a Message. |
| JChannel.java | Class | JChannel is a pure Java implementation of Channel.
When a JChannel object is instantiated it automatically sets up the
protocol stack.
Properties
Properties are used to configure a channel, and are accepted in
several forms; the String form is described here.
A property string consists of a number of properties separated by
colons. |
| JChannelFactory.java | Class | JChannelFactory creates pure Java implementations of the Channel
interface. |
| Membership.java | Class | Class to keep track of Addresses. |
| MembershipListener.java | Interface | Allows a listener to be notified when group membership changes.
These callbacks are used in
org.jgroups.blocks.PullPushAdapter .
The MembershipListener interface is similar to the
MessageListener
interface: every time a new view, a suspicion message, or a
block event is received, the corresponding method of the class implementing
MembershipListener will be called.
Oftentimes the only method containing any functionality will be viewAccepted()
which notifies the receiver that a new member has joined the group or that an
existing member has left or crashed. |
| MergeView.java | Class | A view that is sent as a result of a merge.
Whenever a group splits into subgroups, e.g., due to a network partition,
and later the subgroups merge back together, a MergeView instead of a View
will be received by the application. |
| Message.java | Class | A Message encapsulates data sent to members of a group. |
| MessageListener.java | Interface | Allows a listener to be notified when a message arrives. |
| Receiver.java | Interface | |
| ReceiverAdapter.java | Class | |
| SetStateEvent.java | Class | Encapsulates a state returned by Channel.receive(), as requested by
Channel.getState(s) previously. |
| StreamingGetStateEvent.java | Class | Represents an event returned by channel.receive(), as a result
of another channel instance requesting a state from this channel. |
| StreamingSetStateEvent.java | Class | Represents an event returned by channel.receive(), as requested by
channel.getState() previously.
Allows applications using a channel in a pull mode to receive a state from
another channel instance providing state. |
| SuspectedException.java | Class | Thrown if a message is sent to a suspected member. |
| SuspectEvent.java | Class | Represents a suspect event. |
| TimeoutException.java | Class | Thrown if members fail to respond in time. |
| Transport.java | Interface | Defines a very small subset of the functionality of a channel,
essentially only the methods for sending and receiving messages. |
| UnblockEvent.java | Class | Trivial object that represents a block event. |
| UpHandler.java | Interface | Provides a way of taking over a channel's tasks. |
| Version.java | Class | We're using the scheme described at http://www.jboss.com/index.html?module=bb&op=viewtopic&t=77231
for major, minor and micro version numbers. |
| View.java | Class | A view is a local representation of the current membership of a group. |
| ViewId.java | Class | ViewIds are used for ordering views (each view has a ViewId and a list of members). |