java.lang.Object

org.eclipse.net4j.signal.Signal

All Implemented Interfaces:: Runnable

Direct Known Subclasses:: SignalActor, SignalReactor

public abstract class Signal extends Object implements Runnable

Represents a single communications use-case in the scope of a signal protocol.

Author:: Eike Stepper

Field Summary

Fields

Modifier and Type

Field

Description

static final long

NO_TIMEOUT
Constructor Summary

Constructors

Constructor

Description

Signal(SignalProtocol<?> protocol, short id)

Signal(SignalProtocol<?> protocol, short id, String name)

Both implementation classes of a logical signal must have the same signalID.

Signal(SignalProtocol<?> protocol, Enum<?> literal)
Method Summary

Modifier and Type

Method

Description

protected boolean

closeChannelAfterMe()

protected boolean

closeInputStreamAfterMe()

protected boolean

closeOutputStreamAfterMe()

protected abstract void

execute(BufferInputStream in, BufferOutputStream out)

protected void

finishInputStream(InputStream in)

protected void

finishOutputStream(OutputStream out)

protected final void

flush()

protected String

getAdditionalInfo()

protected final BufferInputStream

getBufferInputStream()

protected final BufferOutputStream

getBufferOutputStream()

final int

getCorrelationID()

protected InputStream

getCurrentInputStream()

protected OutputStream

getCurrentOutputStream()

final short

getID()

Returns the short integer ID of this signal that is unique among all signals of the associated protocol.

String

getName()

SignalProtocol<?>

getProtocol()

protected void

handleRunException(Throwable ex)

final void

run()

String

toString()

String

toString(boolean shortForm)

protected InputStream

wrapInputStream(InputStream in)

protected OutputStream

wrapOutputStream(OutputStream out)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- NO_TIMEOUT
  
  public static final long NO_TIMEOUT
  Since:
  
  2.0
  
  See Also:
  
  Constant Field Values
Constructor Details
- Signal
  
  public Signal(SignalProtocol<?> protocol, short id, String name)
  
  Both implementation classes of a logical signal must have the same signalID. The signalID of a user signals must be equal to or greater than zero.
  
  Since:
  
  2.0
- Signal
  
  public Signal(SignalProtocol<?> protocol, short id)
  Since:
  
  2.0
  
  See Also:
  
  Signal(SignalProtocol, short, String)
- Signal
  
  public Signal(SignalProtocol<?> protocol, Enum<?> literal)
  Since:
  
  2.0
  
  See Also:
  
  Signal(SignalProtocol, short, String)
Method Details
- getProtocol
  
  public SignalProtocol<?> getProtocol()
- getID
  
  public final short getID()
  
  Returns the short integer ID of this signal that is unique among all signals of the associated protocol.
  
  Since:
  
  2.0
- getName
  
  public String getName()
  
  Since:
  
  2.0
- getCorrelationID
  
  public final int getCorrelationID()
  
  Since:
  
  2.0
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
  
  Since:
  
  2.0
- toString
  
  public String toString(boolean shortForm)
  
  Since:
  
  4.13
- getAdditionalInfo
  
  protected String getAdditionalInfo()
  
  Since:
  
  4.5
- run
  
  public final void run()
  
  Specified by:
  
  run in interface Runnable
- getBufferInputStream
  
  protected final BufferInputStream getBufferInputStream()
- getBufferOutputStream
  
  protected final BufferOutputStream getBufferOutputStream()
- flush
  
  protected final void flush() throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  2.0
- closeChannelAfterMe
  
  protected boolean closeChannelAfterMe()
  
  Since:
  
  4.4
- closeInputStreamAfterMe
  
  protected boolean closeInputStreamAfterMe()
  
  Since:
  
  4.5
- closeOutputStreamAfterMe
  
  protected boolean closeOutputStreamAfterMe()
  
  Since:
  
  4.5
- getCurrentInputStream
  
  protected InputStream getCurrentInputStream()
  
  Since:
  
  2.0
- getCurrentOutputStream
  
  protected OutputStream getCurrentOutputStream()
  
  Since:
  
  2.0
- wrapInputStream
  
  protected InputStream wrapInputStream(InputStream in) throws IOException
  
  Throws:
  
  IOException
- wrapOutputStream
  
  protected OutputStream wrapOutputStream(OutputStream out) throws IOException
  
  Throws:
  
  IOException
- finishInputStream
  
  protected void finishInputStream(InputStream in) throws IOException
  
  Throws:
  
  IOException
- finishOutputStream
  
  protected void finishOutputStream(OutputStream out) throws IOException
  
  Throws:
  
  IOException
- handleRunException
  
  protected void handleRunException(Throwable ex) throws Throwable
  
  Throws:
  
  Throwable
  
  Since:
  
  4.19
- execute
  
  protected abstract void execute(BufferInputStream in, BufferOutputStream out) throws Exception
  
  Throws:
  
  Exception

Class Signal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

NO_TIMEOUT

Constructor Details

Signal

Signal

Signal

Method Details

getProtocol

getID

getName

getCorrelationID

toString

toString

getAdditionalInfo

run

getBufferInputStream

getBufferOutputStream

flush

closeChannelAfterMe

closeInputStreamAfterMe

closeOutputStreamAfterMe

getCurrentInputStream

getCurrentOutputStream

wrapInputStream

wrapOutputStream

finishInputStream

finishOutputStream

handleRunException

execute