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.activeio
Class FilterSynchChannelServer

    java.lang.Object
      org.activeio.FilterSynchChannelServer

All Implemented Interfaces:
  Channel, ChannelServer, Disposable, Service, SynchChannelServer

public class FilterSynchChannelServer
extends java.lang.Object
implements SynchChannelServer

A SynchChannelFilter can be used as a filter another `SynchChannel` Most `SynchChannel` that are not directly accessing the network will extends the SynchChannelFilter since they act as a filter between the client and the network.

Version:
  $Revision$

Field Summary

Fields inherited from interface org.activeio.SynchChannelServer
`NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT`

Constructor Summary
`FilterSynchChannelServer(SynchChannelServer next)`

Method Summary
`Channel` | `accept(long timeout)`
`void` | `dispose()` This method should not throw any exceptions.
`java.net.URI` | `getBindURI()` The URI that was used when the channel was bound.
`java.net.URI` | `getConnectURI()` Once bound, the channel may be able to construct a URI that is more sutible for when a client needs to connect to the server.
`SynchChannelServer` | `getNext()`
`java.lang.Object` | `narrow(java.lang.Class target)` Since a Channel may be composed from a chain of other Channel obejcts, this method allows you to query the chain for the specified interface.
`void` | `start()` Starts the channel.
`void` | `stop(long timeout)` Stops the channel.
`java.lang.String` | `toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### FilterSynchChannelServer

    public FilterSynchChannelServer(SynchChannelServer next)

Method Detail

### dispose

    public void dispose()

  Description copied from interface: `Disposable`
  This method should not throw any exceptions. Cleaning up a Disposable object should be easy of an end user therefore do not make him have to handle an Exception.

  Specified by:
    `dispose` in interface `Disposable`
  See Also:
    `Disposable.dispose()`

### start

    public void start()
               throws java.io.IOException

  Description copied from interface: `Service`
  Starts the channel. Once started, the channel is in the running state.

  Specified by:
    `start` in interface `Service`
  Throws:
    `java.io.IOException`
  See Also:
    `Service.start()`

### stop

    public void stop(long timeout)
              throws java.io.IOException

  Description copied from interface: `Service`
  Stops the channel. Once stopped, the channel is in the stopped state.

  Specified by:
    `stop` in interface `Service`
  Parameters:
    `timeout` - The amount of time the channel is allowed to take to gracefully stop. If the timeout is exceeded, the channel should do a forcefull stop.
  Throws:
    `java.io.IOException`
  See Also:
    `Service.stop(long)`

### getNext

    public SynchChannelServer getNext()

  Returns:
    Returns the next.

### accept

    public Channel accept(long timeout)
                   throws java.io.IOException

  Specified by:
    `accept` in interface `SynchChannelServer`
  Throws:
    `java.io.IOException`
  See Also:
    `SynchChannelServer.accept(long)`

### getBindURI

    public java.net.URI getBindURI()

  Description copied from interface: `ChannelServer`
  The URI that was used when the channel was bound. This could be different than what is used by a client to connect to the ChannelServer. For example, the bind URI might be tcp://localhost:0 which means the channel should bind to an anonymous port.

  Specified by:
    `getBindURI` in interface `ChannelServer`
  Returns:
    The URI that was used when the channel was bound
  See Also:
    `ChannelServer.getBindURI()`

### getConnectURI

    public java.net.URI getConnectURI()

  Description copied from interface: `ChannelServer`
  Once bound, the channel may be able to construct a URI that is more sutible for when a client needs to connect to the server. For examle the port of the URI may be updated to reflect the actual local port that the channel server is listening on.

  Specified by:
    `getConnectURI` in interface `ChannelServer`
  Returns:
    a URI that a client can use to connect to the server or null if the channel cannot construct the URI.
  See Also:
    `ChannelServer.getConnectURI()`

### narrow

    public java.lang.Object narrow(java.lang.Class target)

  Description copied from interface: `Channel`
  Since a Channel may be composed from a chain of other Channel obejcts, this method allows you to query the chain for the specified interface. The first Channel in the chain the implments the requested interface will be return an implementing object. If no Channel in the chain implements the requested class, then null is returned.

  Specified by:
    `narrow` in interface `Channel`

### toString

    public java.lang.String toString()

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 © -2005 The ActiveIO Project. All Rights Reserved.