2009-01-09 1.2.0

org.eclipse.soda.dk.transport.service
Interface ControllerService

All Superinterfaces:
ErrorListener, MessageListener, MultiplexMessageListener, MultiplexTransportListener, TransportListener

public interface ControllerService
extends MultiplexTransportListener

Version:
1.2.0

Method Summary
 void closeTransportChannel(ChannelStateService channelState, boolean force)
          Close transport channel with the specified channel parameter.
 void closeTransportChannels()
          Close transport channels and return the Map result.
 ChannelStateService getChannelState(ChannelService channel)
          Get channel state with the specified channel parameter and return the ChannelStateService result.
 void restartTransport()
          Restart transport.
 void scheduleTimeout(ChannelStateService channelState, java.lang.Object startTime, long responseTimeout)
          Schedule timeout with the specified channel state, object and response timeout parameters.
 void start()
          Start the notification service.
 void start(boolean output)
          Start the transport.
 void stop()
          Stop the notification service.
 void stop(boolean output)
          Stop the transport.
 void trace(java.lang.String debugMessage)
          Trace with the specified debug message parameter.
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.MultiplexTransportListener
channelChanged
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.TransportListener
transportChanged
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.MessageListener
messageReceived
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.ErrorListener
errorOccurred
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.MultiplexMessageListener
messageReceived
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.MessageListener
messageReceived
 
Methods inherited from interface org.eclipse.soda.dk.transport.service.ErrorListener
errorOccurred
 

Method Detail

closeTransportChannel

void closeTransportChannel(ChannelStateService channelState,
                           boolean force)
Close transport channel with the specified channel parameter.

Parameters:
channelState - The channel state (ChannelStateService) parameter.
force - The force (boolean) parameter.
Since:
1.2

closeTransportChannels

void closeTransportChannels()
Close transport channels and return the Map result.

Since:
1.2

getChannelState

ChannelStateService getChannelState(ChannelService channel)
Get channel state with the specified channel parameter and return the ChannelStateService result.

Parameters:
channel - The channel (ChannelService) parameter.
Returns:
Results of the get channel state (ChannelStateService) value.
Since:
1.2

restartTransport

void restartTransport()
Restart transport.


scheduleTimeout

void scheduleTimeout(ChannelStateService channelState,
                     java.lang.Object startTime,
                     long responseTimeout)
Schedule timeout with the specified channel state, object and response timeout parameters.

Parameters:
channelState - The channel state (ChannelStateService) parameter.
startTime - The start time (Object) parameter.
responseTimeout - The response timeout (long) parameter.
Since:
1.2

start

void start()
Start the notification service.

See Also:
start(boolean)

start

void start(boolean output)
Start the transport. if true output any errors else do not output errors.

Parameters:
output - The output (boolean) parameter.
See Also:
start()

stop

void stop()
Stop the notification service.

See Also:
stop(boolean)

stop

void stop(boolean output)
Stop the transport. if true output any errors else do not output errors.

Parameters:
output - The output (boolean) parameter.
See Also:
stop()

trace

void trace(java.lang.String debugMessage)
Trace with the specified debug message parameter.

Parameters:
debugMessage - The debug message (String) parameter.

2009-01-09 1.2.0

Copyright (c) 2009 IBM. See license in Legal section.