org.jgroups.blocks

Class Request

java.lang.Object

org.jgroups.blocks.Request

All Implemented Interfaces:

java.util.concurrent.Future, Condition, NotifyingFuture

Direct Known Subclasses:

GroupRequest, UnicastRequest

public abstract class Request
extends java.lang.Object
implements NotifyingFuture, Condition

Abstract class for a unicast or multicast request

Author:

Bela Ban

Field Summary

Fields

Modifier and Type	Field and Description
protected CondVar	cond Is set as soon as the request has received all required responses
protected RequestCorrelator	corr
protected boolean	done
protected FutureListener	listener
protected java.util.concurrent.locks.Lock	lock
protected static Log	log
protected RequestOptions	options
protected long	req_id
protected long	start_time

Constructor Summary

Constructors

Constructor and Description
Request(RequestCorrelator corr, RequestOptions options)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
protected void	checkCompletion(java.util.concurrent.Future future)
protected void	corrDone()
boolean	execute(Message req, boolean block_for_results)
boolean	getResponsesComplete()
boolean	isCancelled()
boolean	isDone()
boolean	isMet() Return true if the condition is met and false otherwise
abstract void	receiveResponse(java.lang.Object response_value, Address sender, boolean is_exception)
long	requestId()
Request	requestId(long req_id)
protected abstract boolean	responsesComplete()
protected boolean	responsesComplete(long timeout) This method runs with lock locked (called by execute()).
protected abstract void	sendRequest(Message request_msg)
NotifyingFuture	setListener(FutureListener listener) Attaches a listener and returns the same future instance, to allow for 'building' futures.
Request	setResponseFilter(RspFilter filter)
abstract void	siteUnreachable(java.lang.String site)
abstract void	suspect(Address mbr)
java.lang.String	toString()
abstract void	transportClosed()
abstract void	viewChange(View new_view)
protected boolean	waitForResults(long timeout)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Future

get, get

Field Detail

log

protected static final Log log

req_id

protected long req_id

lock

protected final java.util.concurrent.locks.Lock lock

cond

protected final CondVar cond

Is set as soon as the request has received all required responses

corr

protected final RequestCorrelator corr

options

protected final RequestOptions options

done

protected volatile boolean done

listener

protected volatile FutureListener listener

start_time

protected long start_time

Constructor Detail

Request

public Request(RequestCorrelator corr,
               RequestOptions options)

Method Detail

requestId

public Request requestId(long req_id)

requestId

public long requestId()

setResponseFilter

public Request setResponseFilter(RspFilter filter)

setListener

public NotifyingFuture setListener(FutureListener listener)

Description copied from interface: NotifyingFuture

Attaches a listener and returns the same future instance, to allow for 'building' futures.

Specified by:

setListener in interface NotifyingFuture

Parameters:

listener - listener to attach

Returns:

the same future instance

execute

public boolean execute(Message req,
                       boolean block_for_results)
                throws java.lang.Exception

Throws:

java.lang.Exception

sendRequest

protected abstract void sendRequest(Message request_msg)
                             throws java.lang.Exception

Throws:

java.lang.Exception

receiveResponse

public abstract void receiveResponse(java.lang.Object response_value,
                                     Address sender,
                                     boolean is_exception)

viewChange

public abstract void viewChange(View new_view)

suspect

public abstract void suspect(Address mbr)

siteUnreachable

public abstract void siteUnreachable(java.lang.String site)

transportClosed

public abstract void transportClosed()

isMet

public boolean isMet()

Description copied from interface: Condition

Return true if the condition is met and false otherwise

Specified by:

isMet in interface Condition

responsesComplete

protected abstract boolean responsesComplete()

getResponsesComplete

public boolean getResponsesComplete()

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

checkCompletion

protected void checkCompletion(java.util.concurrent.Future future)

responsesComplete

protected boolean responsesComplete(long timeout)
                             throws java.lang.InterruptedException

This method runs with lock locked (called by execute()).

Throws:

java.lang.InterruptedException

waitForResults

protected boolean waitForResults(long timeout)

corrDone

protected void corrDone()