org.eclipse.net4j.signal
Class RequestWithMonitoring<RESULT>

java.lang.Object
  extended by org.eclipse.net4j.signal.Signal
      extended by org.eclipse.net4j.signal.SignalActor
          extended by org.eclipse.net4j.signal.RequestWithConfirmation<RESULT>
              extended by org.eclipse.net4j.signal.RequestWithMonitoring<RESULT>
All Implemented Interfaces:
Runnable

public abstract class RequestWithMonitoring<RESULT>
extends RequestWithConfirmation<RESULT>

Since:
2.0

Field Summary
static long DEFAULT_CANCELATION_POLL_INTERVAL
           
static int DEFAULT_MONITOR_PROGRESS_SECONDS
           
static int DEFAULT_MONITOR_TIMEOUT_SECONDS
           
 
Fields inherited from class org.eclipse.net4j.signal.Signal
NO_TIMEOUT
 
Constructor Summary
RequestWithMonitoring(SignalProtocol<?> protocol, Enum<?> literal)
           
RequestWithMonitoring(SignalProtocol<?> protocol, short signalID)
           
RequestWithMonitoring(SignalProtocol<?> protocol, short id, String name)
           
 
Method Summary
protected  RESULT confirming(ExtendedDataInputStream in)
          Important Note: The confirmation must not be empty, i.e. the stream must be used at least to read a boolean.
protected abstract  RESULT confirming(ExtendedDataInputStream in, OMMonitor monitor)
          Important Note: The confirmation must not be empty, i.e. the stream must be used at least to read a boolean.
protected  ExecutorService getCancelationExecutorService()
           
protected  long getCancelationPollInterval()
           
protected  int getConfirmingWorkPercent()
           
protected  int getMonitorProgressSeconds()
           
protected  int getMonitorTimeoutSeconds()
           
protected  int getRequestingWorkPercent()
           
protected  void requesting(ExtendedDataOutputStream out)
           
protected abstract  void requesting(ExtendedDataOutputStream out, OMMonitor monitor)
           
 RESULT send()
           
 RESULT send(long timeout)
           
 RESULT send(long timeout, OMMonitor monitor)
           
 RESULT send(OMMonitor monitor)
           
 Future<RESULT> sendAsync()
           
 Future<RESULT> sendAsync(OMMonitor monitor)
           
 
Methods inherited from class org.eclipse.net4j.signal.RequestWithConfirmation
getAsyncExecutorService
 
Methods inherited from class org.eclipse.net4j.signal.SignalActor
execute
 
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
 

Field Detail

DEFAULT_CANCELATION_POLL_INTERVAL

public static final long DEFAULT_CANCELATION_POLL_INTERVAL
Since:
2.0
See Also:
Constant Field Values

DEFAULT_MONITOR_PROGRESS_SECONDS

public static final int DEFAULT_MONITOR_PROGRESS_SECONDS
Since:
2.0
See Also:
Constant Field Values

DEFAULT_MONITOR_TIMEOUT_SECONDS

public static final int DEFAULT_MONITOR_TIMEOUT_SECONDS
Since:
2.0
See Also:
Constant Field Values
Constructor Detail

RequestWithMonitoring

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

RequestWithMonitoring

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

RequestWithMonitoring

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

sendAsync

public Future<RESULT> sendAsync()
Overrides:
sendAsync in class RequestWithConfirmation<RESULT>

sendAsync

public Future<RESULT> sendAsync(OMMonitor monitor)

send

public RESULT send()
            throws Exception,
                   RemoteException
Overrides:
send in class RequestWithConfirmation<RESULT>
Throws:
Exception
RemoteException

send

public RESULT send(long timeout)
            throws Exception,
                   RemoteException
Overrides:
send in class RequestWithConfirmation<RESULT>
Throws:
Exception
RemoteException

send

public RESULT send(OMMonitor monitor)
            throws Exception,
                   RemoteException
Throws:
Exception
RemoteException

send

public RESULT send(long timeout,
                   OMMonitor monitor)
            throws Exception,
                   RemoteException
Throws:
Exception
RemoteException

requesting

protected final void requesting(ExtendedDataOutputStream out)
                         throws Exception
Specified by:
requesting in class RequestWithConfirmation<RESULT>
Throws:
Exception

confirming

protected final RESULT confirming(ExtendedDataInputStream in)
                           throws Exception
Description copied from class: RequestWithConfirmation
Important Note: The confirmation must not be empty, i.e. the stream must be used at least to read a boolean. Otherwise synchronization problems will result!

Specified by:
confirming in class RequestWithConfirmation<RESULT>
Throws:
Exception

requesting

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

confirming

protected abstract RESULT confirming(ExtendedDataInputStream in,
                                     OMMonitor monitor)
                              throws Exception
Important Note: The confirmation must not be empty, i.e. the stream must be used at least to read a boolean. Otherwise synchronization problems will result!

Throws:
Exception

getCancelationExecutorService

protected ExecutorService getCancelationExecutorService()
Since:
2.0

getCancelationPollInterval

protected long getCancelationPollInterval()
Since:
2.0

getMonitorProgressSeconds

protected int getMonitorProgressSeconds()
Since:
2.0

getMonitorTimeoutSeconds

protected int getMonitorTimeoutSeconds()
Since:
2.0

getRequestingWorkPercent

protected int getRequestingWorkPercent()
Since:
2.0

getConfirmingWorkPercent

protected int getConfirmingWorkPercent()
Since:
2.0


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