java.lang.Object
- org.apache.qpid.protonj2.engine.impl.ProtonEnginePipeline

All Implemented Interfaces:

EnginePipeline
```
public class ProtonEnginePipeline
extends java.lang.Object
implements EnginePipeline
```
Pipeline of EngineHandler instances used to process IO

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProtonEnginePipeline`	`addFirst(java.lang.String name, EngineHandler handler)`	Adds the given handler to the front of the pipeline with the given name stored for later lookup or remove operations.
`ProtonEnginePipeline`	`addLast(java.lang.String name, EngineHandler handler)`	Adds the given handler to the end of the pipeline with the given name stored for later lookup or remove operations.
`ProtonEngine`	`engine()`
`EngineHandler`	`find(java.lang.String name)`	Finds and returns first handler that is found in the pipeline that matches the given name.
`ProtonEnginePipeline`	`fireEngineStarting()`	Fires an engine starting event to each handler in the pipeline.
`ProtonEnginePipeline`	`fireEngineStateChanged()`	Fires an engine state changed event to each handler in the pipeline.
`ProtonEnginePipeline`	`fireFailed(EngineFailedException e)`	Fires an engine failed event into each `EngineHandler` in the pipeline indicating that the engine is now failed and should not accept or produce new work.
`ProtonEnginePipeline`	`fireRead(ProtonBuffer input)`	Fires a read event consisting of the given `ProtonBuffer` into the pipeline starting from the last `EngineHandler` in the pipeline and moving through each until the incoming work is fully processed.
`ProtonEnginePipeline`	`fireRead(HeaderEnvelope header)`	Fires a read event consisting of the given `HeaderEnvelope` into the pipeline starting from the last `EngineHandler` in the pipeline and moving through each until the incoming work is fully processed.
`ProtonEnginePipeline`	`fireRead(IncomingAMQPEnvelope envelope)`	Fires a read event consisting of the given `IncomingAMQPEnvelope` into the pipeline starting from the last `EngineHandler` in the pipeline and moving through each until the incoming work is fully processed.
`ProtonEnginePipeline`	`fireRead(SASLEnvelope envelope)`	Fires a read event consisting of the given `SASLEnvelope` into the pipeline starting from the last `EngineHandler` in the pipeline and moving through each until the incoming work is fully processed.
`ProtonEnginePipeline`	`fireWrite(ProtonBuffer buffer, java.lang.Runnable ioComplete)`	Fires a write event consisting of the given `ProtonBuffer` into the pipeline starting from the first `EngineHandler` in the pipeline and moving through each until the outgoing work is fully processed.
`ProtonEnginePipeline`	`fireWrite(HeaderEnvelope envelope)`	Fires a write event consisting of the given `HeaderEnvelope` into the pipeline starting from the first `EngineHandler` in the pipeline and moving through each until the outgoing work is fully processed.
`ProtonEnginePipeline`	`fireWrite(OutgoingAMQPEnvelope envelope)`	Fires a write event consisting of the given `OutgoingAMQPEnvelope` into the pipeline starting from the first `EngineHandler` in the pipeline and moving through each until the outgoing work is fully processed.
`ProtonEnginePipeline`	`fireWrite(SASLEnvelope envelope)`	Fires a write event consisting of the given `SASLEnvelope` into the pipeline starting from the first `EngineHandler` in the pipeline and moving through each until the outgoing work is fully processed.
`EngineHandler`	`first()`
`EngineHandlerContext`	`firstContext()`
`EngineHandler`	`last()`
`EngineHandlerContext`	`lastContext()`
`ProtonEnginePipeline`	`remove(java.lang.String name)`	Removes the first handler that is found in the pipeline that matches the given name.
`EnginePipeline`	`remove(EngineHandler handler)`	Removes the given `EngineHandler` from the pipeline if present.
`ProtonEnginePipeline`	`removeFirst()`	Removes the first `EngineHandler` in the pipeline.
`ProtonEnginePipeline`	`removeLast()`	Removes the last `EngineHandler` in the pipeline.

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

- Method Detail
  - engine
```
public ProtonEngine engine()
```
    Specified by:
    
    engine in interface EnginePipeline
    
    Returns:
    
    the Engine that this pipeline is linked to.
  - addFirst
```
public ProtonEnginePipeline addFirst(java.lang.String name,
                                     EngineHandler handler)
```
    Description copied from interface: EnginePipeline
    
    Adds the given handler to the front of the pipeline with the given name stored for later lookup or remove operations. It is not mandatory that each handler have unique names although if handlers do share a name the EnginePipeline.remove(String) method will only remove them one at a time starting from the first in the pipeline.
    
    Specified by:
    
    addFirst in interface EnginePipeline
    
    Parameters:
    
    name - The name to assign to the handler
    
    handler - The EngineHandler to add into the pipeline.
    
    Returns:
    
    this EnginePipeline.
  - addLast
```
public ProtonEnginePipeline addLast(java.lang.String name,
                                    EngineHandler handler)
```
    Description copied from interface: EnginePipeline
    
    Adds the given handler to the end of the pipeline with the given name stored for later lookup or remove operations. It is not mandatory that each handler have unique names although if handlers do share a name the EnginePipeline.remove(String) method will only remove them one at a time starting from the first in the pipeline.
    
    Specified by:
    
    addLast in interface EnginePipeline
    
    Parameters:
    
    name - The name to assign to the handler
    
    handler - The EngineHandler to add into the pipeline.
    
    Returns:
    
    this EnginePipeline.
  - removeFirst
```
public ProtonEnginePipeline removeFirst()
```
    Description copied from interface: EnginePipeline
    
    Removes the first EngineHandler in the pipeline.
    
    Specified by:
    
    removeFirst in interface EnginePipeline
    
    Returns:
    
    this EnginePipeline.
  - removeLast
```
public ProtonEnginePipeline removeLast()
```
    Description copied from interface: EnginePipeline
    
    Removes the last EngineHandler in the pipeline.
    
    Specified by:
    
    removeLast in interface EnginePipeline
    
    Returns:
    
    this EnginePipeline.
  - remove
```
public ProtonEnginePipeline remove(java.lang.String name)
```
    Description copied from interface: EnginePipeline
    
    Removes the first handler that is found in the pipeline that matches the given name.
    
    Specified by:
    
    remove in interface EnginePipeline
    
    Parameters:
    
    name - The name to search for in the pipeline moving from first to last.
    
    Returns:
    
    this EnginePipeline.
  - remove
```
public EnginePipeline remove(EngineHandler handler)
```
    Description copied from interface: EnginePipeline
    
    Removes the given EngineHandler from the pipeline if present.
    
    Specified by:
    
    remove in interface EnginePipeline
    
    Parameters:
    
    handler - The handler instance to remove if contained in the pipeline.
    
    Returns:
    
    this EnginePipeline.
  - find
```
public EngineHandler find(java.lang.String name)
```
    Description copied from interface: EnginePipeline
    
    Finds and returns first handler that is found in the pipeline that matches the given name.
    
    Specified by:
    
    find in interface EnginePipeline
    
    Parameters:
    
    name - The name to search for in the pipeline moving from first to last.
    
    Returns:
    
    the EngineHandler that matches the given name or null if none in the pipeline.
  - first
```
public EngineHandler first()
```
    Specified by:
    
    first in interface EnginePipeline
    
    Returns:
    
    the first EngineHandler in the pipeline or null if empty.
  - last
```
public EngineHandler last()
```
    Specified by:
    
    last in interface EnginePipeline
    
    Returns:
    
    the last EngineHandler in the pipeline or null if empty.
  - firstContext
```
public EngineHandlerContext firstContext()
```
    Specified by:
    
    firstContext in interface EnginePipeline
    
    Returns:
    
    the first EngineHandlerContext in the pipeline or null if empty.
  - lastContext
```
public EngineHandlerContext lastContext()
```
    Specified by:
    
    lastContext in interface EnginePipeline
    
    Returns:
    
    the last EngineHandlerContext in the pipeline or null if empty.
  - fireEngineStarting
```
public ProtonEnginePipeline fireEngineStarting()
```
    Description copied from interface: EnginePipeline
    
    Fires an engine starting event to each handler in the pipeline. Should be used by the engine implementation to signal its handlers that they should initialize.
    
    Specified by:
    
    fireEngineStarting in interface EnginePipeline
    
    Returns:
    
    this EnginePipeline.
  - fireEngineStateChanged
```
public ProtonEnginePipeline fireEngineStateChanged()
```
    Description copied from interface: EnginePipeline
    
    Fires an engine state changed event to each handler in the pipeline. Should be used by the engine implementation to signal its handlers that they should respond to the new engine state, e.g. the engine failed or was shutdown.
    
    Specified by:
    
    fireEngineStateChanged in interface EnginePipeline
    
    Returns:
    
    this EnginePipeline.
  - fireFailed
```
public ProtonEnginePipeline fireFailed(EngineFailedException e)
```
    Description copied from interface: EnginePipeline
    
    Fires an engine failed event into each EngineHandler in the pipeline indicating that the engine is now failed and should not accept or produce new work.
    
    Specified by:
    
    fireFailed in interface EnginePipeline
    
    Parameters:
    
    e - The cause of the engine failure.
    
    Returns:
    
    this EnginePipeline.
  - fireRead
```
public ProtonEnginePipeline fireRead(ProtonBuffer input)
```
    Description copied from interface: EnginePipeline
    
    Fires a read event consisting of the given ProtonBuffer into the pipeline starting from the last EngineHandler in the pipeline and moving through each until the incoming work is fully processed. If the read events reaches the head of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state.
    
    Specified by:
    
    fireRead in interface EnginePipeline
    
    Parameters:
    
    input - The ProtonBuffer to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireRead
```
public ProtonEnginePipeline fireRead(HeaderEnvelope header)
```
    Description copied from interface: EnginePipeline
    
    Fires a read event consisting of the given HeaderEnvelope into the pipeline starting from the last EngineHandler in the pipeline and moving through each until the incoming work is fully processed. If the read events reaches the head of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state.
    
    Specified by:
    
    fireRead in interface EnginePipeline
    
    Parameters:
    
    header - The HeaderEnvelope to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireRead
```
public ProtonEnginePipeline fireRead(SASLEnvelope envelope)
```
    Description copied from interface: EnginePipeline
    
    Fires a read event consisting of the given SASLEnvelope into the pipeline starting from the last EngineHandler in the pipeline and moving through each until the incoming work is fully processed. If the read events reaches the head of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state.
    
    Specified by:
    
    fireRead in interface EnginePipeline
    
    Parameters:
    
    envelope - The SASLEnvelope to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireRead
```
public ProtonEnginePipeline fireRead(IncomingAMQPEnvelope envelope)
```
    Description copied from interface: EnginePipeline
    
    Fires a read event consisting of the given IncomingAMQPEnvelope into the pipeline starting from the last EngineHandler in the pipeline and moving through each until the incoming work is fully processed. If the read events reaches the head of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state.
    
    Specified by:
    
    fireRead in interface EnginePipeline
    
    Parameters:
    
    envelope - The IncomingAMQPEnvelope to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireWrite
```
public ProtonEnginePipeline fireWrite(HeaderEnvelope envelope)
```
    Description copied from interface: EnginePipeline
    
    Fires a write event consisting of the given HeaderEnvelope into the pipeline starting from the first EngineHandler in the pipeline and moving through each until the outgoing work is fully processed. If the write events reaches the tail of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state. It is expected that after the fire write method returns the given HeaderEnvelope will have been written or if held for later the object must be copied.
    
    Specified by:
    
    fireWrite in interface EnginePipeline
    
    Parameters:
    
    envelope - The HeaderEnvelope to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireWrite
```
public ProtonEnginePipeline fireWrite(OutgoingAMQPEnvelope envelope)
```
    Description copied from interface: EnginePipeline
    
    Fires a write event consisting of the given OutgoingAMQPEnvelope into the pipeline starting from the first EngineHandler in the pipeline and moving through each until the outgoing work is fully processed. If the write events reaches the tail of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state. It is expected that after the fire write method returns the given OutgoingAMQPEnvelope will have been written or if held for later the object must be copied. When the payload given exceeds the maximum allowed frame size when encoded into an outbound frame the encoding handler should either throw an error in the case that the performative being written cannot truncate its payload or should invoke the payload to large handler of the envelope before re-encoding the outbound performative and truncating the payload.
    
    Specified by:
    
    fireWrite in interface EnginePipeline
    
    Parameters:
    
    envelope - The OutgoingAMQPEnvelope to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireWrite
```
public ProtonEnginePipeline fireWrite(SASLEnvelope envelope)
```
    Description copied from interface: EnginePipeline
    
    Fires a write event consisting of the given SASLEnvelope into the pipeline starting from the first EngineHandler in the pipeline and moving through each until the outgoing work is fully processed. If the write events reaches the tail of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state. It is expected that after the fire write method returns the given SASLEnvelope will have been written or if held for later the object must be copied.
    
    Specified by:
    
    fireWrite in interface EnginePipeline
    
    Parameters:
    
    envelope - The SASLEnvelope to inject into the engine pipeline.
    
    Returns:
    
    this EnginePipeline.
  - fireWrite
```
public ProtonEnginePipeline fireWrite(ProtonBuffer buffer,
                                      java.lang.Runnable ioComplete)
```
    Description copied from interface: EnginePipeline
    
    Fires a write event consisting of the given ProtonBuffer into the pipeline starting from the first EngineHandler in the pipeline and moving through each until the outgoing work is fully processed. If the write events reaches the tail of the pipeline and is not handled by any handler an error is thrown and the engine should enter the failed state.
    
    Specified by:
    
    fireWrite in interface EnginePipeline
    
    Parameters:
    
    buffer - The ProtonBuffer to inject into the engine pipeline.
    
    ioComplete - An optional callback that should be signaled when the underlying transport complete the I/O write
    
    Returns:
    
    this EnginePipeline.

Class ProtonEnginePipeline

Method Summary

Methods inherited from class java.lang.Object

Method Detail

engine

addFirst

addLast

removeFirst

removeLast

remove

remove

find

first

last

firstContext

lastContext

fireEngineStarting

fireEngineStateChanged

fireFailed

fireRead

fireRead

fireRead

fireRead

fireWrite

fireWrite

fireWrite

fireWrite