Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.remoting.transport
Interface ClientInvoker

All Superinterfaces:
  Invoker

All Known Implementing Classes:
  LocalClientInvoker, RemoteClientInvoker

public interface ClientInvoker
extends Invoker

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

Author:
  Tom Elrod

Method Summary
`void` | `connect()` connect to the remote invoker
`void` | `disconnect()` disconnect from the remote invokere
`InvokerLocator` | `getClientLocator()` Gets the client locator.
`Object` | `invoke(InvocationRequest 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 locator)` This should be set when want to override the default behavior of automatically getting s suitable locator.

Methods inherited from interface org.jboss.remoting.Invoker
`getLocator`

Method Detail

### setClientLocator

    public void setClientLocator(InvokerLocator 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 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 Object invoke(InvocationRequest in)
                  throws Throwable

  transport a request against a remote ServerInvoker

  Parameters:
    `in` -
  Returns:
  Throws:
    `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

  connect to the remote invoker

  Throws:
    `ConnectionFailedException`

### disconnect

    public void disconnect()

  disconnect from the remote invokere

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.