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

java.lang.Object
  org.eclipse.net4j.signal.Signal
      org.eclipse.net4j.signal.SignalActor
          org.eclipse.net4j.signal.RequestWithConfirmation<RESULT>
              org.eclipse.net4j.signal.RequestWithMonitoring<RESULT>

All Implemented Interfaces:

Runnable

public abstract class RequestWithMonitoring<RESULT>

extends RequestWithConfirmation<RESULT>

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

Since:

2.0

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

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

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