org.eclipse.net4j.signal
Class IndicationWithMonitoring

java.lang.Object
  extended by org.eclipse.net4j.signal.Signal
      extended by org.eclipse.net4j.signal.SignalReactor
          extended by org.eclipse.net4j.signal.IndicationWithResponse
              extended by org.eclipse.net4j.signal.IndicationWithMonitoring
All Implemented Interfaces:
Runnable

public abstract class IndicationWithMonitoring
extends IndicationWithResponse

Represents the receiver side of a two-way signal with additional support for remote progress monitoring.

Since:
2.0

Field Summary
 
Fields inherited from class org.eclipse.net4j.signal.Signal
NO_TIMEOUT
 
Constructor Summary
IndicationWithMonitoring(SignalProtocol<?> protocol, Enum<?> literal)
           
IndicationWithMonitoring(SignalProtocol<?> protocol, short signalID)
           
IndicationWithMonitoring(SignalProtocol<?> protocol, short id, String name)
           
 
Method Summary
protected  void execute(BufferInputStream in, BufferOutputStream out)
           
protected  int getIndicatingWorkPercent()
           
protected  ExecutorService getMonitoringExecutorService()
           
protected  void indicating(ExtendedDataInputStream in)
           
protected abstract  void indicating(ExtendedDataInputStream in, OMMonitor monitor)
           
protected  void responding(ExtendedDataOutputStream out)
          Important Note: The response must not be empty, i.e. the stream must be used at least to write a boolean.
protected abstract  void responding(ExtendedDataOutputStream out, OMMonitor monitor)
           
 
Methods inherited from class org.eclipse.net4j.signal.IndicationWithResponse
getExceptionMessage
 
Methods inherited from class org.eclipse.net4j.signal.Signal
finishInputStream, finishOutputStream, flush, getBufferInputStream, getBufferOutputStream, getCorrelationID, getCurrentInputStream, getCurrentOutputStream, getID, getName, getProtocol, run, toString, wrapInputStream, wrapOutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IndicationWithMonitoring

public IndicationWithMonitoring(SignalProtocol<?> protocol,
                                short id,
                                String name)
Since:
2.0

IndicationWithMonitoring

public IndicationWithMonitoring(SignalProtocol<?> protocol,
                                short signalID)
Since:
2.0

IndicationWithMonitoring

public IndicationWithMonitoring(SignalProtocol<?> protocol,
                                Enum<?> literal)
Since:
2.0
Method Detail

execute

protected void execute(BufferInputStream in,
                       BufferOutputStream out)
                throws Exception
Overrides:
execute in class IndicationWithResponse
Throws:
Exception

indicating

protected final void indicating(ExtendedDataInputStream in)
                         throws Exception
Specified by:
indicating in class IndicationWithResponse
Throws:
Exception

responding

protected final void responding(ExtendedDataOutputStream out)
                         throws Exception
Description copied from class: IndicationWithResponse
Important Note: The response must not be empty, i.e. the stream must be used at least to write a boolean. Otherwise synchronization problems will result!

Specified by:
responding in class IndicationWithResponse
Throws:
Exception

indicating

protected abstract void indicating(ExtendedDataInputStream in,
                                   OMMonitor monitor)
                            throws Exception
Throws:
Exception

responding

protected abstract void responding(ExtendedDataOutputStream out,
                                   OMMonitor monitor)
                            throws Exception
Throws:
Exception

getMonitoringExecutorService

protected ExecutorService getMonitoringExecutorService()
Since:
2.0

getIndicatingWorkPercent

protected int getIndicatingWorkPercent()


Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) and others.