Package org.jgroups.protocols.pbcast

Class ViewHandler<R>

java.lang.Object

org.jgroups.protocols.pbcast.ViewHandler<R>

Type Parameters:

R - the type of the request

public class ViewHandler<R>
extends Object

Responsible for dispatching JOIN/LEAVE/MERGE requests to the GMS protocol. Bundles multiple concurrent requests into a request list

Since:

4.0.5

Field Summary

Fields

Modifier and Type	Field	Description
protected final GMS	gms
protected final BoundedList<String>	history
protected final Lock	lock
protected final AtomicBoolean	processing
protected final Condition	processing_done
protected BiPredicate<R,R>	req_matcher
protected Consumer<Collection<R>>	req_processor
protected final Collection<R>	requests
protected final AtomicBoolean	suspended

Constructor Summary

Constructors

Constructor	Description
ViewHandler(GMS gms, Consumer<Collection<R>> req_processor, BiPredicate<R,R> req_matcher)	Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	_add(Collection<R> reqs)
protected boolean	_add(R req)
protected boolean	_add(R... reqs)
ViewHandler<R>	add(Collection<R> reqs)
ViewHandler<R>	add(R req)
ViewHandler<R>	add(R... reqs)
String	dumpHistory()
String	dumpQueue()
protected Log	log()
protected void	process()	We're guaranteed that only one thread will be called with this method at any time
boolean	processing()
<T extends ViewHandler<R>> T	processing(boolean flag)	To be used by testing only!
protected Collection<R>	remove(Collection<R> requests)	Removes requests as long as they match - breaks at the first non-matching request or when requests is empty This method must catch all exceptions; or else process() might return without setting processing to true again!
BiPredicate<R,R>	reqMatcher()
ViewHandler<R>	reqMatcher(BiPredicate<R,R> m)
Consumer<Collection<R>>	reqProcessor()
ViewHandler<R>	reqProcessor(Consumer<Collection<R>> p)
void	resume()
int	size()
void	suspend()	Clears the queue and discards new requests from now on
boolean	suspended()
String	toString()
void	waitUntilComplete()	Blocks the caller until the current set of requests being processed have been completed.
void	waitUntilComplete(long timeout)	Blocks the caller until the current set of requests being processed have been completed, or the timeout elapsed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

requests

protected final Collection<R> requests

lock

protected final Lock lock

suspended

protected final AtomicBoolean suspended

processing

protected final AtomicBoolean processing

processing_done

protected final Condition processing_done

gms

protected final GMS gms

req_processor

protected Consumer<Collection<R>> req_processor

req_matcher

protected BiPredicate<R,R> req_matcher

history

protected final BoundedList<String> history

Constructor Details

ViewHandler

public ViewHandler(GMS gms,
 Consumer<Collection<R>> req_processor,
 BiPredicate<R,R> req_matcher)

Constructor

Parameters:

gms - The ref to GMS

req_processor - A request processor which processes a list of requests

req_matcher - The matcher which determines whether any given 2 requests can be processed together

Method Details

suspended

public boolean suspended()

processing

public boolean processing()

size

public int size()

reqProcessor

public ViewHandler<R> reqProcessor(Consumer<Collection<R>> p)

reqProcessor

public Consumer<Collection<R>> reqProcessor()

reqMatcher

public ViewHandler<R> reqMatcher(BiPredicate<R,R> m)

reqMatcher

public BiPredicate<R,R> reqMatcher()

add

public ViewHandler<R> add(R req)

add

public ViewHandler<R> add(R... reqs)

add

public ViewHandler<R> add(Collection<R> reqs)

suspend

public void suspend()

Clears the queue and discards new requests from now on

resume

public void resume()

waitUntilComplete

public void waitUntilComplete()

Blocks the caller until the current set of requests being processed have been completed. Returns immediately if no requests are currently being processed

waitUntilComplete

public void waitUntilComplete(long timeout)

Blocks the caller until the current set of requests being processed have been completed, or the timeout elapsed.

Returns immediately if no requests are currently being processed

Parameters:

timeout - Max time to wait in milliseconds

processing

public <T extends ViewHandler<R>> T processing(boolean flag)

To be used by testing only!

dumpQueue

public String dumpQueue()

dumpHistory

public String dumpHistory()

toString

public String toString()

Overrides:

toString in class Object

log

protected Log log()

_add

protected boolean _add(R req)

_add

protected boolean _add(R... reqs)

_add

protected boolean _add(Collection<R> reqs)

process

protected void process()

We're guaranteed that only one thread will be called with this method at any time

remove

protected Collection<R> remove(Collection<R> requests)

Removes requests as long as they match - breaks at the first non-matching request or when requests is empty This method must catch all exceptions; or else process() might return without setting processing to true again!