com.fr.third.jgroups.blocks

类 ReplicatedHashMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

com.fr.third.jgroups.blocks.ReplicatedHashMap<K,V>

所有已实现的接口:

ReplicatedMap<K,V>, MembershipListener, MessageListener, Receiver, java.util.concurrent.ConcurrentMap<K,V>, java.util.Map<K,V>

public class ReplicatedHashMap<K,V>
extends java.util.AbstractMap<K,V>
implements java.util.concurrent.ConcurrentMap<K,V>, Receiver, ReplicatedMap<K,V>

Implementation of a ConcurrentMap with replication of the contents across a cluster. Any change to the hashmap (clear(), put(), remove() etc) will transparently be propagated to all replicas in the group. All read-only methods will always access the local replica.

Keys and values added to the hashmap must be serializable, the reason being that they will be sent across the network to all replicas of the group.

A ReplicatedHashMap allows one to implement a distributed naming service in just a couple of lines.

An instance of this class will contact an existing member of the group to fetch its initial state.

作者:

Bela Ban

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	ReplicatedHashMap.Notification<K,V>

从类继承的嵌套类/接口 java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

从接口继承的嵌套类/接口 java.util.Map

java.util.Map.Entry<K,V>

字段概要

字段

限定符和类型	字段和说明
protected RequestOptions	call_options
protected RpcDispatcher	disp
protected Log	log
protected java.util.concurrent.ConcurrentMap<K,V>	map wrapped map instance
protected static java.util.Map<java.lang.Short,java.lang.reflect.Method>	methods

构造器概要

构造器

构造器和说明
ReplicatedHashMap(Channel channel) Constructs a new ReplicatedHashMap with channel.
ReplicatedHashMap(java.util.concurrent.ConcurrentMap<K,V> map, Channel channel) Constructs a new ReplicatedHashMap using provided map instance.

方法概要

方法

限定符和类型	方法和说明
void	_clear()
V	_put(K key, V value)
void	_putAll(java.util.Map<? extends K,? extends V> map)
V	_putIfAbsent(K key, V value)
V	_remove(java.lang.Object key)
boolean	_remove(java.lang.Object key, java.lang.Object value)
V	_replace(K key, V value)
boolean	_replace(K key, V oldValue, V newValue)
void	addNotifier(ReplicatedHashMap.Notification n)
void	block() Block sending and receiving of messages until ViewAccepted is called
void	clear() Removes all of the mappings from this map.
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
V	get(java.lang.Object key)
Channel	getChannel()
java.lang.String	getClusterName()
Address	getLocalAddress()
void	getState(java.io.OutputStream ostream) Allows an application to write a state through a provided OutputStream.
long	getTimeout() The timeout (in milliseconds) for blocking updates
protected void	init()
boolean	isBlockingUpdates()
java.util.Set<K>	keySet()
V	put(K key, V value) Maps the specified key to the specified value in this table.
void	putAll(java.util.Map<? extends K,? extends V> m) Copies all of the mappings from the specified map to this one.
V	putIfAbsent(K key, V value)
void	receive(Message msg) Called when a message is received.
V	remove(java.lang.Object key) Removes the key (and its corresponding value) from this map.
boolean	remove(java.lang.Object key, java.lang.Object value)
void	removeNotifier(ReplicatedHashMap.Notification n)
V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	setBlockingUpdates(boolean blocking_updates) Whether updates across the cluster should be asynchronous (default) or synchronous)
void	setState(java.io.InputStream istream) Allows an application to read a state through a provided InputStream.
void	setTimeout(long timeout) Sets the cluster call timeout (until all acks have been received)
int	size()
void	start(long state_timeout) Fetches the state
void	stop()
void	suspect(Address suspected_mbr) Called when a member is suspected
static <K,V> ReplicatedMap<K,V>	synchronizedMap(ReplicatedMap<K,V> map) Creates a synchronized facade for a ReplicatedMap.
void	unblock() Called after the FLUSH protocol has unblocked previously blocked senders, and messages can be sent again.
java.util.Collection<V>	values()
void	viewAccepted(View new_view) Called when a change in membership has occurred.

从类继承的方法 java.util.AbstractMap

clone, equals, hashCode, isEmpty, toString

从类继承的方法 java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.Map

equals, hashCode, isEmpty

字段详细资料

methods

protected static java.util.Map<java.lang.Short,java.lang.reflect.Method> methods

disp

protected RpcDispatcher disp

call_options

protected final RequestOptions call_options

log

protected final Log log

map

protected java.util.concurrent.ConcurrentMap<K,V> map

wrapped map instance

构造器详细资料

ReplicatedHashMap

public ReplicatedHashMap(Channel channel)

Constructs a new ReplicatedHashMap with channel. Call start(long) to start this map.

ReplicatedHashMap

public ReplicatedHashMap(java.util.concurrent.ConcurrentMap<K,V> map,
                 Channel channel)

Constructs a new ReplicatedHashMap using provided map instance.

方法详细资料

init

protected final void init()

isBlockingUpdates

public boolean isBlockingUpdates()

setBlockingUpdates

public void setBlockingUpdates(boolean blocking_updates)

Whether updates across the cluster should be asynchronous (default) or synchronous)

参数:

blocking_updates -

getTimeout

public long getTimeout()

The timeout (in milliseconds) for blocking updates

setTimeout

public void setTimeout(long timeout)

Sets the cluster call timeout (until all acks have been received)

参数:

timeout - The timeout (in milliseconds) for blocking updates

start

public final void start(long state_timeout)
                 throws java.lang.Exception

Fetches the state

参数:

state_timeout -

抛出:

java.lang.Exception

getLocalAddress

public Address getLocalAddress()

getClusterName

public java.lang.String getClusterName()

getChannel

public Channel getChannel()

addNotifier

public void addNotifier(ReplicatedHashMap.Notification n)

removeNotifier

public void removeNotifier(ReplicatedHashMap.Notification n)

stop

public void stop()

put

public V put(K key,
    V value)

Maps the specified key to the specified value in this table. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

指定者:

put 在接口中 java.util.Map<K,V>

覆盖:

put 在类中 java.util.AbstractMap<K,V>

参数:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

返回:

the previous value associated with key, or null if there was no mapping for key

抛出:

java.lang.NullPointerException - if the specified key or value is null

putIfAbsent

public V putIfAbsent(K key,
            V value)

指定者:

putIfAbsent 在接口中 java.util.concurrent.ConcurrentMap<K,V>

返回:

the previous value associated with the specified key, or null if there was no mapping for the key

抛出:

java.lang.NullPointerException - if the specified key or value is null

putAll

public void putAll(java.util.Map<? extends K,? extends V> m)

Copies all of the mappings from the specified map to this one. These mappings replace any mappings that this map had for any of the keys currently in the specified map.

指定者:

putAll 在接口中 java.util.Map<K,V>

覆盖:

putAll 在类中 java.util.AbstractMap<K,V>

参数:

m - mappings to be stored in this map

clear

public void clear()

Removes all of the mappings from this map.

指定者:

clear 在接口中 java.util.Map<K,V>

覆盖:

clear 在类中 java.util.AbstractMap<K,V>

remove

public V remove(java.lang.Object key)

Removes the key (and its corresponding value) from this map. This method does nothing if the key is not in the map.

指定者:

remove 在接口中 java.util.Map<K,V>

覆盖:

remove 在类中 java.util.AbstractMap<K,V>

参数:

key - the key that needs to be removed

返回:

the previous value associated with key, or null if there was no mapping for key

抛出:

java.lang.NullPointerException - if the specified key is null

remove

public boolean remove(java.lang.Object key,
             java.lang.Object value)

指定者:

remove 在接口中 java.util.concurrent.ConcurrentMap<K,V>

抛出:

java.lang.NullPointerException - if the specified key is null

replace

public boolean replace(K key,
              V oldValue,
              V newValue)

指定者:

replace 在接口中 java.util.concurrent.ConcurrentMap<K,V>

抛出:

java.lang.NullPointerException - if any of the arguments are null

replace

public V replace(K key,
        V value)

指定者:

replace 在接口中 java.util.concurrent.ConcurrentMap<K,V>

返回:

the previous value associated with the specified key, or null if there was no mapping for the key

抛出:

java.lang.NullPointerException - if the specified key or value is null

_put

public V _put(K key,
     V value)

指定者:

_put 在接口中 ReplicatedMap<K,V>

_putIfAbsent

public V _putIfAbsent(K key,
             V value)

指定者:

_putIfAbsent 在接口中 ReplicatedMap<K,V>

_putAll

public void _putAll(java.util.Map<? extends K,? extends V> map)

指定者:

_putAll 在接口中 ReplicatedMap<K,V>

另请参阅:

Map.putAll(java.util.Map)

_clear

public void _clear()

指定者:

_clear 在接口中 ReplicatedMap<K,V>

_remove

public V _remove(java.lang.Object key)

指定者:

_remove 在接口中 ReplicatedMap<K,V>

_remove

public boolean _remove(java.lang.Object key,
              java.lang.Object value)

指定者:

_remove 在接口中 ReplicatedMap<K,V>

_replace

public boolean _replace(K key,
               V oldValue,
               V newValue)

指定者:

_replace 在接口中 ReplicatedMap<K,V>

_replace

public V _replace(K key,
         V value)

指定者:

_replace 在接口中 ReplicatedMap<K,V>

receive

public void receive(Message msg)

从接口复制的说明: MessageListener

Called when a message is received.

指定者:

receive 在接口中 MessageListener

getState

public void getState(java.io.OutputStream ostream)
              throws java.lang.Exception

从接口复制的说明: MessageListener

Allows an application to write a state through a provided OutputStream. After the state has been written the OutputStream doesn't need to be closed as stream closing is automatically done when a calling thread returns from this callback.

指定者:

getState 在接口中 MessageListener

参数:

ostream - the OutputStream

抛出:

java.lang.Exception - if the streaming fails, any exceptions should be thrown so that the state requester can re-throw them and let the caller know what happened

另请参阅:

OutputStream.close()

setState

public void setState(java.io.InputStream istream)
              throws java.lang.Exception

从接口复制的说明: MessageListener

Allows an application to read a state through a provided InputStream. After the state has been read the InputStream doesn't need to be closed as stream closing is automatically done when a calling thread returns from this callback.

指定者:

setState 在接口中 MessageListener

参数:

istream - the InputStream

抛出:

java.lang.Exception - if the streaming fails, any exceptions should be thrown so that the state requester can catch them and thus know what happened

另请参阅:

InputStream.close()

viewAccepted

public void viewAccepted(View new_view)

从接口复制的说明: MembershipListener

Called when a change in membership has occurred. No long running actions, sending of messages or anything that could block should be done in this callback. If some long running action needs to be performed, it should be done in a separate thread.

Note that on reception of the first view (a new member just joined), the channel will not yet be in the connected state. This only happens when Channel.connect(String) returns.

指定者:

viewAccepted 在接口中 MembershipListener

suspect

public void suspect(Address suspected_mbr)

Called when a member is suspected

指定者:

suspect 在接口中 MembershipListener

block

public void block()

Block sending and receiving of messages until ViewAccepted is called

指定者:

block 在接口中 MembershipListener

unblock

public void unblock()

从接口复制的说明: MembershipListener

Called after the FLUSH protocol has unblocked previously blocked senders, and messages can be sent again. This callback only needs to be implemented if we require a notification of that.

Note that during new view installation we provide guarantee that unblock invocation strictly follows view installation at some node A belonging to that view . However, some other message M may squeeze in between view and unblock callbacks.

For more details see https://jira.jboss.org/jira/browse/JGRP-986

指定者:

unblock 在接口中 MembershipListener

synchronizedMap

public static <K,V> ReplicatedMap<K,V> synchronizedMap(ReplicatedMap<K,V> map)

Creates a synchronized facade for a ReplicatedMap. All methods which change state are invoked through a monitor. This is similar to , but also includes the replication methods (starting with an underscore).

参数:

map -

返回:

containsKey

public boolean containsKey(java.lang.Object key)

指定者:

containsKey 在接口中 java.util.Map<K,V>

覆盖:

containsKey 在类中 java.util.AbstractMap<K,V>

containsValue

public boolean containsValue(java.lang.Object value)

指定者:

containsValue 在接口中 java.util.Map<K,V>

覆盖:

containsValue 在类中 java.util.AbstractMap<K,V>

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()

指定者:

entrySet 在接口中 java.util.Map<K,V>

指定者:

entrySet 在类中 java.util.AbstractMap<K,V>

get

public V get(java.lang.Object key)

指定者:

get 在接口中 java.util.Map<K,V>

覆盖:

get 在类中 java.util.AbstractMap<K,V>

keySet

public java.util.Set<K> keySet()

指定者:

keySet 在接口中 java.util.Map<K,V>

覆盖:

keySet 在类中 java.util.AbstractMap<K,V>

size

public int size()

指定者:

size 在接口中 java.util.Map<K,V>

覆盖:

size 在类中 java.util.AbstractMap<K,V>

values

public java.util.Collection<V> values()

指定者:

values 在接口中 java.util.Map<K,V>

覆盖:

values 在类中 java.util.AbstractMap<K,V>