org.jboss.remoting.transport
Interface ClientInvoker

All Superinterfaces:
Invoker (src)
All Known Implementing Classes:
LocalClientInvoker (src) , RemoteClientInvoker (src)

public interface ClientInvoker
extends Invoker (src)

Interface to be used for calling on all the different invoker types (LocalClientInvoker and RemoteClientInvoker).


Method Summary
 void connect()
          connect to the remote invoker
 void disconnect()
          disconnect from the remote invokere
 InvokerLocator (src) getClientLocator()
          Gets the client locator.
 Marshaller (src) getMarshaller()
           
 UnMarshaller (src) getUnMarshaller()
           
 java.lang.Object invoke(InvocationRequest (src)  in)
          transport a request against a remote ServerInvoker
 boolean isConnected()
          subclasses must provide this method to return true if their remote connection is connected and false if disconnected.
 void setClientLocator(InvokerLocator (src)  locator)
          This should be set when want to override the default behavior of automatically getting s suitable locator.
 void setMarshaller(Marshaller (src)  marshaller)
           
 void setUnMarshaller(UnMarshaller (src)  unmarshaller)
           
 
Methods inherited from interface org.jboss.remoting.Invoker (src)
getLocator
 

Method Detail

setClientLocator

public void setClientLocator(InvokerLocator (src)  locator)
This should be set when want to override the default behavior of automatically getting s suitable locator. This should be used want want to control what type of callbacks to receive (pull or push). Set to null to poll for callback messages. This can also be used to receive callbacks using another transport and subsystem, if desired.

Parameters:
locator -

getClientLocator

public InvokerLocator (src)  getClientLocator()
Gets the client locator. This locator will be used by the server side to make callbacks to the handler for this locator.

Returns:

invoke

public java.lang.Object invoke(InvocationRequest (src)  in)
                        throws java.lang.Throwable
transport a request against a remote ServerInvoker

Parameters:
in -
Returns:
Throws:
java.lang.Throwable

isConnected

public boolean isConnected()
subclasses must provide this method to return true if their remote connection is connected and false if disconnected. in some transports, such as SOAP, this method may always return true, since the remote connectivity is done on demand and not kept persistent like other transports (such as socket-based transport).

Returns:
boolean true if connected, false if not

connect

public void connect()
             throws ConnectionFailedException (src) 
connect to the remote invoker

Throws:
ConnectionFailedException (src)

disconnect

public void disconnect()
disconnect from the remote invokere


setMarshaller

public void setMarshaller(Marshaller (src)  marshaller)

getMarshaller

public Marshaller (src)  getMarshaller()

setUnMarshaller

public void setUnMarshaller(UnMarshaller (src)  unmarshaller)

getUnMarshaller

public UnMarshaller (src)  getUnMarshaller()