Apache.Qpid.Proton.Engine.IEnginePipeline Interface Reference

The engine pipeline contains a list of handlers that deal with incoming and outgoing AMQP frames such as logging and encoders and decoders. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.IEnginePipeline:

Public Member Functions
IEnginePipeline	AddFirst (string name, IEngineHandler handler)
	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 remove method will only remove them one at a time starting from the first in the pipeline.
IEnginePipeline	AddLast (string name, IEngineHandler handler)
	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 remove method will only remove them one at a time starting from the first in the pipeline.
IEnginePipeline	RemoveFirst ()
	Removes the first handler in the pipeline.
IEnginePipeline	RemoveLast ()
	Removes the first handler in the pipeline.
IEnginePipeline	Remove (string name)
	Removes the first handler in the pipeline that is assigned the given name.
IEnginePipeline	Remove (IEngineHandler handler)
	Removes the given handler if found in the pipeline.
IEngineHandler	Find (string name)
	Finds and returns first handler that is found in the pipeline that matches the given name.
IEngineHandler	First ()
	Finds and returns first handler in the pipeline.
IEngineHandler	Last ()
	Finds and returns last handler in the pipeline.
IEngineHandlerContext	FirstContext ()
	Returns a reference to the first engine handler context in the pipeline.
IEngineHandlerContext	LastContext ()
	Returns a reference to the last engine handler context in the pipeline.
IEnginePipeline	FireEngineStarting ()
	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.
IEnginePipeline	FireEngineStateChanged ()
	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.
IEnginePipeline	FireRead (IProtonBuffer input)
	Fires a read event consisting of the given proton buffer into the pipeline starting from the last engine handler 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.
IEnginePipeline	FireRead (HeaderEnvelope header)
	Fires a read event consisting of the given header envelope into the pipeline starting from the last engine handler 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.
IEnginePipeline	FireRead (SaslEnvelope envelope)
	Fires a read event consisting of the given SASL envelope into the pipeline starting from the last engine handler 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.
IEnginePipeline	FireRead (IncomingAmqpEnvelope envelope)
	Fires a read event consisting of the given AMQP envelope into the pipeline starting from the last engine handler 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.
IEnginePipeline	FireWrite (HeaderEnvelope envelope)
	Fires a write event consisting of the given header envelope into the pipeline starting from the first engine 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 envelope will have been written or if held for later the object must be copied.
IEnginePipeline	FireWrite (OutgoingAmqpEnvelope envelope)
	Fires a write event consisting of the given AMQP envelope into the pipeline starting from the first engine 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 envelope 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.
IEnginePipeline	FireWrite (SaslEnvelope envelope)
	Fires a write event consisting of the given SASL envelope into the pipeline starting from the first engine 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 envelope will have been written or if held for later the object must be copied.
IEnginePipeline	FireWrite (IProtonBuffer buffer, Action ioComplete)
	Fires a write event consisting of the given proton buffer into the pipeline starting from the first engine 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.
IEnginePipeline	FireFailed (EngineFailedException failure)
	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.

Properties
IEngine	Engine [get]
	Provides access to the engine that owns this engine pipeline.

Detailed Description

The engine pipeline contains a list of handlers that deal with incoming and outgoing AMQP frames such as logging and encoders and decoders.

Member Function Documentation

AddFirst()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.AddFirst	(	string	name,
		IEngineHandler	handler
	)

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 remove method will only remove them one at a time starting from the first in the pipeline.

Parameters

name	The name to assign to the added handler
handler	The handler to add

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

AddLast()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.AddLast	(	string	name,
		IEngineHandler	handler
	)

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 remove method will only remove them one at a time starting from the first in the pipeline.

Parameters

name	The name to assign to the added handler
handler	The handler to add

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

Find()

IEngineHandler Apache.Qpid.Proton.Engine.IEnginePipeline.Find

(

string

name

)

Finds and returns first handler that is found in the pipeline that matches the given name.

Parameters

name	The name to search for in the pipeline moving from first to last.

Returns

The removed handler or null if not found.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireEngineStarting()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireEngineStarting

(

)

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.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireEngineStateChanged()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireEngineStateChanged

(

)

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.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireFailed()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireFailed

(

EngineFailedException

failure

)

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.

Parameters

failure

The error that indicates why the engine has failed

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireRead() [1/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireRead

(

HeaderEnvelope

header

)

Fires a read event consisting of the given header envelope into the pipeline starting from the last engine handler 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.

Parameters

header

The header envelope to process

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireRead() [2/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireRead

(

IncomingAmqpEnvelope

envelope

)

Fires a read event consisting of the given AMQP envelope into the pipeline starting from the last engine handler 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.

Parameters

envelope

The AMQP envelope to process

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireRead() [3/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireRead

(

IProtonBuffer

input

)

Fires a read event consisting of the given proton buffer into the pipeline starting from the last engine handler 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.

Parameters

input

The incoming bytes read in a proton buffer instance.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireRead() [4/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireRead

(

SaslEnvelope

envelope

)

Fires a read event consisting of the given SASL envelope into the pipeline starting from the last engine handler 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.

Parameters

envelope

The SASL envelope to process

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireWrite() [1/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireWrite

(

HeaderEnvelope

envelope

)

Fires a write event consisting of the given header envelope into the pipeline starting from the first engine 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 envelope will have been written or if held for later the object must be copied.

Parameters

envelope

The SASL envelope to process

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireWrite() [2/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireWrite	(	IProtonBuffer	buffer,
		Action	ioComplete
	)

Fires a write event consisting of the given proton buffer into the pipeline starting from the first engine 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.

Parameters

buffer
ioComplete	The delegate to invoke when the IO operation is complete

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireWrite() [3/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireWrite

(

OutgoingAmqpEnvelope

envelope

)

Fires a write event consisting of the given AMQP envelope into the pipeline starting from the first engine 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 envelope 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.

Parameters

envelope

The AMQP envelope to process

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FireWrite() [4/4]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.FireWrite

(

SaslEnvelope

envelope

)

Fires a write event consisting of the given SASL envelope into the pipeline starting from the first engine 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 envelope will have been written or if held for later the object must be copied.

Parameters

envelope

The SASL envelope to process

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

First()

IEngineHandler Apache.Qpid.Proton.Engine.IEnginePipeline.First

(

)

Finds and returns first handler in the pipeline.

Returns

The removed handler or null if not found.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

FirstContext()

IEngineHandlerContext Apache.Qpid.Proton.Engine.IEnginePipeline.FirstContext

(

)

Returns a reference to the first engine handler context in the pipeline.

Returns

An engine handler context instance or null if no handlers in the pipeline

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

Last()

IEngineHandler Apache.Qpid.Proton.Engine.IEnginePipeline.Last

(

)

Finds and returns last handler in the pipeline.

Returns

The removed handler or null if not found.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

LastContext()

IEngineHandlerContext Apache.Qpid.Proton.Engine.IEnginePipeline.LastContext

(

)

Returns a reference to the last engine handler context in the pipeline.

Returns

An engine handler context instance or null if no handlers in the pipeline

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

Remove() [1/2]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.Remove

(

IEngineHandler

handler

)

Removes the given handler if found in the pipeline.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

Remove() [2/2]

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.Remove

(

string

name

)

Removes the first handler in the pipeline that is assigned the given name.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

RemoveFirst()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.RemoveFirst

(

)

Removes the first handler in the pipeline.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

RemoveLast()

IEnginePipeline Apache.Qpid.Proton.Engine.IEnginePipeline.RemoveLast

(

)

Removes the first handler in the pipeline.

Returns

This engine pipeline instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

Property Documentation

Engine

IEngine Apache.Qpid.Proton.Engine.IEnginePipeline.Engine

get

Provides access to the engine that owns this engine pipeline.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipeline, and Apache.Qpid.Proton.Engine.Implementation.ProtonEnginePipelineProxy.

---

The documentation for this interface was generated from the following file:

• src/Proton/Engine/IEnginePipeline.cs