# Package org.jgroups.blocks

Provides building blocks that are layered on top of channels.

See: Description

Interface Summary
Interface | Description
--- | ---
AbstractConnectionMap.ConnectionMapListener<V> |
BasicConnectionTable.ConnectionListener | Used to be notified about connection establishment and teardown.
BasicConnectionTable.Receiver | Used for message reception.
Cache.ChangeListener |
Connection |
ConnectionMap<V extends Connection> |
DistributedQueue.Notification |
DistributedTree.DistributedTreeListener |
DistributedTree.ViewListener |
LazyRemovalCache.Printable<K,V> |
LazyRemovalSet.Printable<V> |
LockManager | Deprecated
MethodLookup |
NotificationBus.Consumer |
PartitionedHashMap.HashFunction<K> |
ReplCache.ChangeListener |
ReplCache.HashFunction<K> |
ReplCache.HashFunctionFactory<K> |
ReplicatedHashMap.Notification<K extends Serializable,V extends Serializable> |
ReplicatedMap<K extends Serializable,V extends Serializable> |
ReplicatedTree.ReplicatedTreeListener |
RequestHandler |
RpcDispatcher.Marshaller |
RpcDispatcher.Marshaller2 |
RspCollector |
RspFilter | Interface defining when a group request is done.
TCPConnectionMap.Receiver | Used for message reception.
TwoPhaseVotingListener | Implementations of this interface can participate in two-phase voting process.
VoteResponseProcessor | VoteResultProcessor Applications that use the VotingAdapter and/or TwoPhaseVotingAdapter can pass an implementation of this down the vote calls, to intercept processing of the VoteResults returned by other nodes.
VotingListener | Implemetations of this interface are able to participate in voting process.

Class Summary
Class | Description
--- | ---
AbstractConnectionMap<V extends Connection> |
BasicConnectionTable | Shared class for TCP connection tables.
Cache<K,V> | Simple cache which maintains keys and value.
Cache.Value<V> |
ConnectionTableNIO | Manages incoming and outgoing TCP connections.
ConnectionTableNIO.MyFuture |
ConnectionTableNIO.SelectorWriteHandler |
ConnectionTableNIO.WriteRequest |
DistributedLockManager | Deprecated Succeessor is `LockService`.
DistributedLockManager.AcquireLockDecree | This class represents the lock to be released.
DistributedLockManager.LockDecree | This class represents the lock
DistributedLockManager.MultiLockDecree | This class represents the lock that has to be marked as multilocked
DistributedLockManager.ReleaseLockDecree | This class represents the lock to be released.
DistributedQueue | Provides the abstraction of a java.util.LinkedList that is replicated at several locations.
DistributedTree | A tree-like structure that is replicated across several members.
GridFile | Subclass of File to iterate through directories and files in a grid
GridFile.Metadata |
GridFilesystem | Entry point for GridFile and GridInputStream / GridOutputStream
GridInputStream |
GridOutputStream |
GroupRequest | Sends a message to all members of the group and waits for all responses (or timeout).
LazyRemovalCache<K,V> | Cache which doesn't remove elements on remove(), removeAll() or retainAll(), but only removes elements when a configurable size limit has been exceeded.
LazyRemovalSet<V> | Hash set which doesn't remove elements on remove(), removeAll() or retainAll(), but only removes elements when a configurable size limit has been exceeded.
LazyRemovalSet.Entry<V> |
MembershipListenerAdapter | This class provides multiplexing possibilities for `MembershipListener` instances.
MemcachedConnector | Class which listens on a server socket for memcached clients, reads the requests, forwards them to an instance of PartitionedHashMap and sends the response.
MemcachedConnector.Request |
MessageDispatcher | Provides synchronous and asynchronous message sending with request-response correlation; i.e., matching responses with the original request.
MessageListenerAdapter | This class provides multiplexing possibilities for `MessageListener` instances.
MethodCall | A method call is the JGroups representation of a remote method.
MultiRequest | Sends a request to multiple destinations.
NotificationBus | Deprecated Will be pulled in 3.0, use a JChannel directly instead
PartitionedHashMap<K,V> | Hashmap which distributes its keys and values across the cluster.
PartitionedHashMap.ArrayBasedConsistentHashFunction<K> | Uses arrays to store hash values of addresses, plus addresses.
PartitionedHashMap.ConsistentHashFunction<K> |
PullPushAdapter | Deprecated Use `Receiver` instead, this class will be removed in JGroups 3.0
PullPushAdapter.PullHeader |
ReplCache<K,V> | Cache which allows for replication factors per data items; the factor determines how many replicas of a key/value we create across the cluster. See doc/design/ReplCache.txt for details.
ReplCache.ConsistentHashFunction<K> |
ReplCache.Value<V> | Uses arrays to store hash values of addresses, plus addresses.
ReplicatedHashMap<K extends Serializable,V extends Serializable> | Subclass of a `ConcurrentHashMap` with replication of the contents across a cluster.
ReplicatedTree | A tree-like structure that is replicated across several members.
ReplicatedTree.Node |
Request | Abstract class for a unicast or multicast request
RequestCorrelator | Framework to send requests and receive matching responses (matching on request ID).
RequestCorrelator.Header | The header for `RequestCorrelator` messages
RequestCorrelator.MultiDestinationHeader |
RequestOptions | Class which captures a bunch of options relevant to remote method invocation or message sending
RpcDispatcher | This class allows a programmer to invoke remote methods in all (or single) group members and optionally wait for the return value(s).
RpcDispatcher.MarshallerAdapter | Used to provide a Marshaller2 interface to a Marshaller.
TCPConnectionMap |
TwoPhaseVotingAdapter | This adapter introduces simple two-phase voting on a specified decree.
TwoPhaseVotingAdapter.TwoPhaseVoteWrapper |
TwoPhaseVotingAdapter.TwoPhaseWrapper | Wrapper of the decree to voting decree.
UnicastRequest<T> | Sends a request to a single target destination
VotingAdapter | Voting adapter provides a voting functionality for an application.
VotingAdapter.FailureVoteResult | Class that represents a result of local voting on the failed node.
VotingAdapter.VoteResult | This class represents the result of local voting.

Enum Summary
Enum | Description
--- | ---
MemcachedConnector.Request.Type |

Exception Summary
Exception | Description
--- | ---
LockingException |
LockMultiLockedException | Thrown by the `DistributedLockManager.unlock(Object, Object, boolean)` method if a lock is only locally released, because it is locked by multiple DistributedLockManagers.
LockNotGrantedException | This exception indicated that lock manager refused to give a lock on some resource.
LockNotReleasedException | This exception indicated that lock manager refused to release a lock on some resource.
UpdateException |
VoteException | This exception is thrown when voting listener cannot vote on the specified decree.

## Package org.jgroups.blocks Description

Provides building blocks that are layered on top of channels. Most of them do not even need a channel, all they need is a class that implements interface Transport (channels do). This enables them to work on any type of group transport that obeys this interface. Building blocks can be used instead of channels whenever a higher-level interface is required. Whereas channels are simple socket-like constructs, building blocks may offer a far more sophisticated interface. In some cases, building blocks offer access to the underlying channel, so that - if the building block at hand does not offer a certain functionality - the channel can be accessed directly.