Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Class AbstractChannel

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.AbstractChannel
All Implemented Interfaces:
AsyncChannel, AsyncInvokerSupport, Channel, ChannelListenerSupport, ConfigurationSupport, ConnectionInvokerSupport, EndpointSupport
Direct Known Subclasses:
DuplexChannel, ServerChannel

public abstract class AbstractChannel
extends java.lang.Object
implements Channel, ConfigurationSupport, EndpointSupport, AsyncInvokerSupport, ConnectionInvokerSupport


Field Summary
 
Fields inherited from interface com.genesyslab.platform.commons.protocol.Channel
DEFAULT_TIMEOUT, INFINITE_TIMEOUT
 
Method Summary
 void addChannelListener(ChannelListener listener)
          Add listener about connection lifecicle events.
 void configure(ConnectionConfiguration config)
           
 ConnectionConfiguration getConfiguration()
           
 Endpoint getEndpoint()
           
 ChannelState getState()
          Return channel state.
 long getTimeout()
          Return timeout.
 void removeChannelListener(ChannelListener listener)
          Remove listener about connection lifecicle events.
 void setConnectionInvoker(AsyncInvoker connectionInvoker)
          Set AsyncInvoker to be used by underlying connection layer.
 void setEndpoint(Endpoint endpoint)
           
 void setInvoker(AsyncInvoker invoker)
           
 void setTimeout(long timeout)
          Set timeout for long operations.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Channel
close, close, open, open
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.AsyncChannel
beginClose, beginOpen
 

Method Detail

getState

public ChannelState getState()
Description copied from interface: AsyncChannel
Return channel state. Note that the state returned is just a hint. It could change any time (e.g. just after this method returns).

Specified by:
getState in interface AsyncChannel
Returns:
State of the connection

setTimeout

public void setTimeout(long timeout)
Set timeout for long operations. Please see class description for timeout values meaning.

Specified by:
setTimeout in interface Channel
Parameters:
timeout - timeout in milliseconds

getTimeout

public long getTimeout()
Description copied from interface: Channel
Return timeout. Please see class description for timeout values meaning.

Specified by:
getTimeout in interface Channel
Returns:
timeout

addChannelListener

public void addChannelListener(ChannelListener listener)
Description copied from interface: ChannelListenerSupport
Add listener about connection lifecicle events.

Specified by:
addChannelListener in interface ChannelListenerSupport
Parameters:
listener - listener

removeChannelListener

public void removeChannelListener(ChannelListener listener)
Description copied from interface: ChannelListenerSupport
Remove listener about connection lifecicle events.

Specified by:
removeChannelListener in interface ChannelListenerSupport
Parameters:
listener - listener

setInvoker

public void setInvoker(AsyncInvoker invoker)
Specified by:
setInvoker in interface AsyncInvokerSupport

setConnectionInvoker

public void setConnectionInvoker(AsyncInvoker connectionInvoker)
Set AsyncInvoker to be used by underlying connection layer. please be sure you have a good uderstanding of ways the connection layer works before you use this method.

Specified by:
setConnectionInvoker in interface ConnectionInvokerSupport
Parameters:
connectionInvoker - invoker for connection layer

getConfiguration

public ConnectionConfiguration getConfiguration()
Specified by:
getConfiguration in interface ConfigurationSupport

configure

public void configure(ConnectionConfiguration config)
Specified by:
configure in interface ConfigurationSupport

getEndpoint

public Endpoint getEndpoint()
Specified by:
getEndpoint in interface EndpointSupport

setEndpoint

public void setEndpoint(Endpoint endpoint)
Specified by:
setEndpoint in interface EndpointSupport

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.