Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jgroups.blocks

Class RpcDispatcher

Implemented Interfaces:
ChannelListener, RequestHandler
public class RpcDispatcher
extends MessageDispatcher
implements ChannelListener
This class allows a programmer to invoke remote methods in all (or single) group members and optionally wait for the return value(s). An application will typically create a channel and layer the RpcDispatcher building block on top of it, which allows it to dispatch remote methods (client role) and at the same time be called by other members (server role). This class is derived from MessageDispatcher. Is the equivalent of RpcProtocol on the application rather than protocol level.
Author:
Bela Ban

Nested Class Summary

static interface
RpcDispatcher.Marshaller

Field Summary

protected List
additionalChannelListeners
protected RpcDispatcher.Marshaller
marshaller
protected MethodLookup
method_lookup
protected Object
server_obj

Fields inherited from class org.jgroups.blocks.MessageDispatcher

adapter, channel, concurrent_processing, corr, deadlock_detection, id, local_addr, log, members, membership_listener, msg_listener, prot_adapter, req_handler, transport_adapter

Constructor Summary

RpcDispatcher(Channel channel, MessageListener l, MembershipListener l2, Object server_obj)
RpcDispatcher(Channel channel, MessageListener l, MembershipListener l2, Object server_obj, boolean deadlock_detection)
RpcDispatcher(Channel channel, MessageListener l, MembershipListener l2, Object server_obj, boolean deadlock_detection, boolean concurrent_processing)
RpcDispatcher(PullPushAdapter adapter, Serializable id, MessageListener l, MembershipListener l2, Object server_obj)

Method Summary

boolean
addChannelListener(ChannelListener l)
Add a new channel listener to be notified on the channel's state change.
Object
callRemoteMethod(Address dest, String method_name, Object[] args, Class[] types, int mode, long timeout)
Object
callRemoteMethod(Address dest, String method_name, Object[] args, String[] signature, int mode, long timeout)
Object
callRemoteMethod(Address dest, MethodCall method_call, int mode, long timeout)
RspList
callRemoteMethods(Vector dests, String method_name, Object[] args, Class[] types, int mode, long timeout)
RspList
callRemoteMethods(Vector dests, String method_name, Object[] args, String[] signature, int mode, long timeout)
RspList
callRemoteMethods(Vector dests, MethodCall method_call, int mode, long timeout)
RspList
castMessage(Vector dests, Message msg, int mode, long timeout)
void
channelClosed(Channel channel)
void
channelConnected(Channel channel)
void
channelDisconnected(Channel channel)
void
channelReconnected(Address new_addr)
void
channelShunned()
RpcDispatcher.Marshaller
getMarshaller()
MethodLookup
getMethodLookup()
String
getName()
Object
getServerObject()
Object
handle(Message req)
Message contains MethodCall.
boolean
removeChannelListener(ChannelListener l)
Object
sendMessage(Message msg, int mode, long timeout)
void
setMarshaller(RpcDispatcher.Marshaller m)
void
setMethodLookup(MethodLookup method_lookup)

Methods inherited from class org.jgroups.blocks.MessageDispatcher

castMessage, castMessage, done, getChannel, getMessageListener, handle, send, sendMessage, setConcurrentProcessing, setDeadlockDetection, setMembershipListener, setMessageListener, setRequestHandler, start, stop

Field Details

additionalChannelListeners

protected List additionalChannelListeners

marshaller

protected RpcDispatcher.Marshaller marshaller

method_lookup

protected MethodLookup method_lookup

server_obj

protected Object server_obj

Constructor Details

RpcDispatcher

public RpcDispatcher(Channel channel,
                     MessageListener l,
                     MembershipListener l2,
                     Object server_obj)

RpcDispatcher

public RpcDispatcher(Channel channel,
                     MessageListener l,
                     MembershipListener l2,
                     Object server_obj,
                     boolean deadlock_detection)

RpcDispatcher

public RpcDispatcher(Channel channel,
                     MessageListener l,
                     MembershipListener l2,
                     Object server_obj,
                     boolean deadlock_detection,
                     boolean concurrent_processing)

RpcDispatcher

public RpcDispatcher(PullPushAdapter adapter,
                     Serializable id,
                     MessageListener l,
                     MembershipListener l2,
                     Object server_obj)

Method Details

addChannelListener

public boolean addChannelListener(ChannelListener l)
Add a new channel listener to be notified on the channel's state change.
Returns:
true if the listener was added or false if the listener was already in the list.

callRemoteMethod

public Object callRemoteMethod(Address dest,
                               String method_name,
                               Object[] args,
                               Class[] types,
                               int mode,
                               long timeout)
            throws TimeoutException,
                   SuspectedException

callRemoteMethod

public Object callRemoteMethod(Address dest,
                               String method_name,
                               Object[] args,
                               String[] signature,
                               int mode,
                               long timeout)
            throws TimeoutException,
                   SuspectedException

callRemoteMethod

public Object callRemoteMethod(Address dest,
                               MethodCall method_call,
                               int mode,
                               long timeout)
            throws TimeoutException,
                   SuspectedException

callRemoteMethods

public RspList callRemoteMethods(Vector dests,
                                 String method_name,
                                 Object[] args,
                                 Class[] types,
                                 int mode,
                                 long timeout)

callRemoteMethods

public RspList callRemoteMethods(Vector dests,
                                 String method_name,
                                 Object[] args,
                                 String[] signature,
                                 int mode,
                                 long timeout)

callRemoteMethods

public RspList callRemoteMethods(Vector dests,
                                 MethodCall method_call,
                                 int mode,
                                 long timeout)

castMessage

public RspList castMessage(Vector dests,
                           Message msg,
                           int mode,
                           long timeout)
Overrides:
castMessage in interface MessageDispatcher

channelClosed

public void channelClosed(Channel channel)
Specified by:
channelClosed in interface ChannelListener

channelConnected

public void channelConnected(Channel channel)
Specified by:
channelConnected in interface ChannelListener

channelDisconnected

public void channelDisconnected(Channel channel)
Specified by:
channelDisconnected in interface ChannelListener

channelReconnected

public void channelReconnected(Address new_addr)
Specified by:
channelReconnected in interface ChannelListener

channelShunned

public void channelShunned()
Specified by:
channelShunned in interface ChannelListener

getMarshaller

public RpcDispatcher.Marshaller getMarshaller()

getMethodLookup

public MethodLookup getMethodLookup()

getName

public String getName()

getServerObject

public Object getServerObject()

handle

public Object handle(Message req)
Message contains MethodCall. Execute it against *this* object and return result. Use MethodCall.invoke() to do this. Return result.
Specified by:
handle in interface RequestHandler
Overrides:
handle in interface MessageDispatcher

removeChannelListener

public boolean removeChannelListener(ChannelListener l)
Returns:
true if the channel was removed indeed.

sendMessage

public Object sendMessage(Message msg,
                          int mode,
                          long timeout)
            throws TimeoutException,
                   SuspectedException
Overrides:
sendMessage in interface MessageDispatcher

setMarshaller

public void setMarshaller(RpcDispatcher.Marshaller m)

setMethodLookup

public void setMethodLookup(MethodLookup method_lookup)

Overview Package Class Use Tree Index Deprecated About
Copyright B) 1998-2005 Bela Ban. All Rights Reserved.