org.eclipse.ecf.datashare
Interface IAbstractChannel

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IIdentifiable
All Known Subinterfaces:
IChannel
All Known Implementing Classes:
BaseChannel, NIOChannel

public interface IAbstractChannel
extends org.eclipse.core.runtime.IAdaptable, IIdentifiable

Super interface for IChannel.


Method Summary
 void dispose()
          Dispose this channel.
 IChannelListener getListener()
          Get IChannelListener instance for this IAbstractChannel
 IChannelListener setListener(IChannelListener listener)
          Set listener to new IChannelListener instance
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.ecf.core.identity.IIdentifiable
getID
 

Method Detail

getListener

IChannelListener getListener()
Get IChannelListener instance for this IAbstractChannel

Returns:
IChannelListener for this IAbstractChannel instance. If null, the channel has no listener.

setListener

IChannelListener setListener(IChannelListener listener)
Set listener to new IChannelListener instance

Parameters:
listener - the new listener to set for this channel. If null, then there will be no new listener for this channel.
Returns:
IChannelListener that was previously the listener. If null, then then channel had no previous listener

dispose

void dispose()
Dispose this channel. This method will typically be called by the enclosing container during IAbstractChannelContainerAdapter.removeChannel(org.eclipse.ecf.core.identity.ID).