# Package org.jgroups

Provides top-level public JGroups classes such as Channel, Message, etc.

See: Description

Interface Summary
Interface | Description
--- | ---
Address | Abstract address.
ChannelFactory | Deprecated Might get removed in 3.0.
ChannelListener | Allows a listener to be notified when important channel events occur.
ExtendedMembershipListener |
ExtendedMessageListener | `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
ExtendedReceiver | Extends Receiver, plus the partial state transfer methods.
MembershipListener | Allows a listener to be notified when group membership changes.
MessageListener | Allows a listener to be notified when a message arrives.
PhysicalAddress | Represents a physical (as opposed to logical) address
Receiver | Defines the callbacks that are invoked when messages, views etc are received on a channel
Transport | Defines a very small subset of the functionality of a channel, essentially only the methods for sending and receiving messages.
UpHandler | Provides a way of taking over a channel's tasks.

Class Summary
Class | Description
--- | ---
BlockEvent | Trivial object that represents a block event.
Channel | A channel represents a group communication endpoint (like BSD datagram sockets).
ChannelListenerAdapter | Class which implements `ChannelListener`
Event | Used for inter-stack and intra-stack communication.
ExtendedReceiverAdapter |
GetStateEvent | Represents a GetState event.
Global | Globals used by JGroups packages.
Header | Abstract base class for all headers to be added to a Message.
JChannel | JChannel is a pure Java implementation of Channel.
JChannelFactory | Deprecated Might get removed in 3.0.
Membership | Class to keep track of Addresses.
MergeView | A view that is sent as a result of a merge.
Message | A Message encapsulates data sent to members of a group.
ReceiverAdapter |
SetStateEvent | Encapsulates a state returned by `Channel.receive()`, as requested by `Channel.getState(s)` previously.
StreamingGetStateEvent | Represents an event returned by `channel.receive()`, as a result of another channel instance requesting a state from this channel.
StreamingSetStateEvent | Represents an event returned by `channel.receive()`, as requested by `channel.getState()` previously.
SuspectEvent | Represents a suspect event.
UnblockEvent | Trivial object that represents a block event.
Version | 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 | A view is a local representation of the current membership of a group.
ViewId | ViewIds are used for ordering views (each view has a ViewId and a list of members).

Exception Summary
Exception | Description
--- | ---
ChannelClosedException | Thrown if an operation is attemped on a closed channel.
ChannelException | This class represents the super class for all exception types thrown by JGroups.
ChannelNotConnectedException | Thrown if an operation is attemped on an unconnected channel.
StateTransferException | `StateTransferException` is thrown to indicate failure of state transfer between cluster members.
SuspectedException | Thrown if a message is sent to a suspected member.
TimeoutException | Thrown if members fail to respond in time.

## Package org.jgroups Description

Provides top-level public JGroups classes such as Channel, Message, etc.