public class RequestCorrelator extends Object
RspCollector
is looked up (key = id) and its
method receiveResponse()
invoked. A caller may use
done()
to signal that no more responses are expected, and that
the corresponding entry may be removed.
RequestCorrelator
can be installed at both client and server
sides, it can also switch roles dynamically; i.e., send a request and at
the same time process an incoming request (when local delivery is enabled,
this is actually the default).
Modifier and Type | Class and Description |
---|---|
static class |
RequestCorrelator.Header
The header for RequestCorrelator messages
|
static class |
RequestCorrelator.MultiDestinationHeader |
Modifier and Type | Field and Description |
---|---|
protected short |
id
makes the instance unique (together with IDs)
|
protected Address |
local_addr
The address of this group member
|
protected static Log |
log |
protected RpcDispatcher.Marshaller2 |
marshaller
Possibility for an external marshaller to marshal/unmarshal responses
|
protected RequestHandler |
request_handler
The handler for the incoming requests.
|
protected ConcurrentMap<Long,RspCollector> |
requests
The table of pending requests (keys=Long (request IDs), values=RequestEntry)
|
protected boolean |
started |
protected Object |
transport
The protocol layer to use to pass up/down messages.
|
Constructor and Description |
---|
RequestCorrelator(Object transport,
RequestHandler handler,
Address local_addr) |
RequestCorrelator(short id,
Object transport,
RequestHandler handler,
Address local_addr) |
RequestCorrelator(String name,
Object transport,
RequestHandler handler)
Deprecated.
|
RequestCorrelator(String name,
Object transport,
RequestHandler handler,
Address local_addr)
Deprecated.
|
RequestCorrelator(String name,
Object transport,
RequestHandler handler,
Address local_addr,
boolean concurrent_processing)
Deprecated.
|
RequestCorrelator(String name,
Object transport,
RequestHandler handler,
boolean deadlock_detection)
Deprecated.
|
RequestCorrelator(String name,
Object transport,
RequestHandler handler,
boolean deadlock_detection,
Address local_addr)
Deprecated.
|
RequestCorrelator(String name,
Object transport,
RequestHandler handler,
boolean deadlock_detection,
Address local_addr,
boolean concurrent_processing)
Deprecated.
|
RequestCorrelator(String name,
Object transport,
RequestHandler handler,
boolean deadlock_detection,
boolean concurrent_processing)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
done(long id)
Used to signal that a certain request may be garbage collected as all responses have been received.
|
Address |
getLocalAddress() |
RpcDispatcher.Marshaller |
getMarshaller() |
protected void |
handleRequest(Message req,
RequestCorrelator.Header hdr)
Handle a request msg for this correlator
|
protected void |
prepareResponse(Message rsp) |
boolean |
receive(Event evt)
Callback.
|
boolean |
receiveMessage(Message msg)
Handles a message coming from a layer below
|
void |
receiveSuspect(Address mbr)
Event.SUSPECT event received from a layer below.
|
void |
receiveView(View new_view)
Event.VIEW_CHANGE event received from a layer below.
|
void |
registerProbeHandler(TP transport) |
void |
sendRequest(long id,
Collection<Address> dest_mbrs,
Message msg,
RspCollector coll,
RequestOptions options)
Sends a request to a group.
|
void |
sendRequest(long id,
List<Address> dest_mbrs,
Message msg,
RspCollector coll) |
void |
sendRequest(long id,
Message msg,
RspCollector coll)
Deprecated.
|
void |
sendUnicastRequest(long id,
Address target,
Message msg,
RspCollector coll)
Sends a request to a single destination
|
void |
setConcurrentProcessing(boolean concurrent_processing)
Deprecated.
Not needed since the introduction of the concurrent stack
|
void |
setDeadlockDetection(boolean flag)
Deprecated.
deadlock detection is not needed with a concurrent stack
|
void |
setLocalAddress(Address local_addr) |
void |
setMarshaller(RpcDispatcher.Marshaller marshaller) |
void |
setRequestHandler(RequestHandler handler) |
void |
start() |
void |
stop() |
void |
unregisterProbeHandler(TP transport) |
protected Object transport
protected final ConcurrentMap<Long,RspCollector> requests
protected RequestHandler request_handler
protected RpcDispatcher.Marshaller2 marshaller
protected short id
protected Address local_addr
protected boolean started
protected static final Log log
@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler)
handler
is not null, all incoming requests will be dispatched to it (via
handle(Message)
).name
- Used to differentiate between different RequestCorrelators
(e.g. in different protocol layers). Has to be unique if multiple
request correlators are used.transport
- Used to send/pass up requests. Can be either a Transport (only send() will be
used then), or a Protocol (up_prot.up()/down_prot.down() will be used)handler
- Request handler. Method handle(Message)
will be called when a request is received.@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler, Address local_addr)
public RequestCorrelator(short id, Object transport, RequestHandler handler, Address local_addr)
public RequestCorrelator(Object transport, RequestHandler handler, Address local_addr)
@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler, boolean deadlock_detection)
handler
is not null, all incoming requests will be dispatched to it (via
handle(Message)
).name
- Used to differentiate between different RequestCorrelators
(e.g. in different protocol layers). Has to be unique if multiple
request correlators are used.transport
- Used to send/pass up requests. Can be either a Transport (only send() will be
used then), or a Protocol (up_prot.up()/down_prot.down() will be used)handler
- Request handler. Method handle(Message)
will be called when a request is received.deadlock_detection
- When enabled (true) recursive synchronous
message calls will be detected and processed with higher priority in
order to solve deadlocks. Slows down processing a little bit when
enabled due to runtime checks involved.@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler, boolean deadlock_detection, boolean concurrent_processing)
@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler, boolean deadlock_detection, Address local_addr)
@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler, boolean deadlock_detection, Address local_addr, boolean concurrent_processing)
@Deprecated public RequestCorrelator(String name, Object transport, RequestHandler handler, Address local_addr, boolean concurrent_processing)
public void setDeadlockDetection(boolean flag)
flag
- the deadlock detection flagpublic void setRequestHandler(RequestHandler handler)
public void setConcurrentProcessing(boolean concurrent_processing)
concurrent_processing
- @Deprecated public void sendRequest(long id, Message msg, RspCollector coll) throws Exception
sendRequest(long,List,Message,RspCollector)
.Exception
public RpcDispatcher.Marshaller getMarshaller()
public void setMarshaller(RpcDispatcher.Marshaller marshaller)
public void sendRequest(long id, List<Address> dest_mbrs, Message msg, RspCollector coll) throws Exception
Exception
public void sendRequest(long id, Collection<Address> dest_mbrs, Message msg, RspCollector coll, RequestOptions options) throws Exception
id
- The request ID. Must be unique for this JVM (e.g. current time in millisecs)dest_mbrs
- The list of members who should receive the call. Usually a group RPC
is sent via multicast, but a receiver drops the request if its own address
is not in this list. Will not be used if it is null.msg
- The request to be sent. The body of the message carries
the request datacoll
- A response collector (usually the object that invokes this method). Its methods
receiveResponse()
and suspect()
will be invoked when a message has been received
or a member is suspected, respectively.Exception
public void sendUnicastRequest(long id, Address target, Message msg, RspCollector coll) throws Exception
id
- target
- msg
- coll
- Exception
public void done(long id)
public boolean receive(Event evt)
Called by the protocol below when a message has been received. The
algorithm should test whether the message is destined for us and,
if not, pass it up to the next layer. Otherwise, it should remove
the header and check whether the message is a request or response.
In the first case, the message will be delivered to the request
handler registered (calling its handle()
method), in the
second case, the corresponding response collector is looked up and
the message delivered.
evt
- The event to be receivedpublic final void start()
public void stop()
public void registerProbeHandler(TP transport)
public void unregisterProbeHandler(TP transport)
public void receiveSuspect(Address mbr)
All response collectors currently registered will
be notified that mbr
may have crashed, so they won't
wait for its response.
public void receiveView(View new_view)
Mark all responses from members that are not in new_view as NOT_RECEIVED.
public boolean receiveMessage(Message msg)
public Address getLocalAddress()
public void setLocalAddress(Address local_addr)
protected void handleRequest(Message req, RequestCorrelator.Header hdr)
req
- the request msgprotected void prepareResponse(Message rsp)
Copyright © 2013 JBoss, a division of Red Hat. All Rights Reserved.