Package org.eclipse.net4j.signal

# Klasse Signal

java.lang.Object
org.eclipse.net4j.signal.Signal

Alle implementierten Schnittstellen:
  `Runnable`, `org.eclipse.net4j.util.container.IManagedContainerProvider`

Bekannte direkte Unterklassen:
  `SignalActor`, `SignalReactor`

public abstract class Signal extends Object implements Runnable, org.eclipse.net4j.util.container.IManagedContainerProvider
Represents a single communications use-case in the scope of a `signal protocol`.

Autor:
  Eike Stepper

## Feldübersicht

Felder
Modifizierer und Typ
Feld
Beschreibung
`static final long`
`NO_TIMEOUT`

## Konstruktorübersicht

Konstruktoren
Konstruktor
Beschreibung
`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)`

## Methodenübersicht

Modifizierer und Typ
Methode
Beschreibung
`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()`
`org.eclipse.net4j.util.container.IManagedContainer`
`getContainer()`
`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)`

### Von Klasse geerbte Methoden java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

## Felddetails

### NO_TIMEOUT

public static final long NO_TIMEOUT

Seit:
  2.0
Siehe auch:
  - Konstantenfeldwerte

## Konstruktordetails

### 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.

Seit:
  2.0

### Signal

public Signal(SignalProtocol<?> protocol, short id)

Seit:
  2.0
Siehe auch:
  - `Signal(SignalProtocol, short, String)`

### Signal

public Signal(SignalProtocol<?> protocol, Enum<?> literal)

Seit:
  2.0
Siehe auch:
  - `Signal(SignalProtocol, short, String)`

## Methodendetails

### 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`.

Seit:
  2.0

### getName

public String getName()

Seit:
  2.0

### getCorrelationID

public final int getCorrelationID()

Seit:
  2.0

### getContainer

public org.eclipse.net4j.util.container.IManagedContainer getContainer()

Angegeben von:
  `getContainer` in Schnittstelle `org.eclipse.net4j.util.container.IManagedContainerProvider`

### toString

public String toString()

Setzt außer Kraft:
  `toString` in Klasse `Object`
Seit:
  2.0

### toString

public String toString(boolean shortForm)

Seit:
  4.13

### getAdditionalInfo

protected String getAdditionalInfo()

Seit:
  4.5

### run

public final void run()

Angegeben von:
  `run` in Schnittstelle `Runnable`

### getBufferInputStream

protected final BufferInputStream getBufferInputStream()

### getBufferOutputStream

protected final BufferOutputStream getBufferOutputStream()

### flush

protected final void flush() throws IOException

Löst aus:
  `IOException`
Seit:
  2.0

### closeChannelAfterMe

protected boolean closeChannelAfterMe()

Seit:
  4.4

### closeInputStreamAfterMe

protected boolean closeInputStreamAfterMe()

Seit:
  4.5

### closeOutputStreamAfterMe

protected boolean closeOutputStreamAfterMe()

Seit:
  4.5

### getCurrentInputStream

protected InputStream getCurrentInputStream()

Seit:
  2.0

### getCurrentOutputStream

protected OutputStream getCurrentOutputStream()

Seit:
  2.0

### wrapInputStream

protected InputStream wrapInputStream(InputStream in) throws IOException

Löst aus:
  `IOException`

### wrapOutputStream

protected OutputStream wrapOutputStream(OutputStream out) throws IOException

Löst aus:
  `IOException`

### finishInputStream

protected void finishInputStream(InputStream in) throws IOException

Löst aus:
  `IOException`

### finishOutputStream

protected void finishOutputStream(OutputStream out) throws IOException

Löst aus:
  `IOException`

### handleRunException

protected void handleRunException(Throwable ex) throws Throwable

Löst aus:
  `Throwable`
Seit:
  4.19

### execute

protected abstract void execute(BufferInputStream in, BufferOutputStream out) throws Exception

Löst aus:
  `Exception`