Context object that is provided to the engine handler APIs to allow for forwarding of events to the next handler or other updates. More...

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

Public Member Functions
void	FireEngineStarting ()
	Fires the engine starting event into the next handler in the engine pipeline.

void	FireEngineStateChanged ()
	Fires the engine state changed event into the next handler in the `EnginePipeline` chain. The state change events occur after the engine starting event and generally signify that the engine has been shutdown normally.

void	FireFailed (EngineFailedException ex)
	Fires the engine failed event into the next handler in the {engine pipeline chain.

void	FireRead (IProtonBuffer buffer)
	Fires a read event into the previous handler in the engine pipeline for further processing or dispatch to the next in line.

void	FireRead (HeaderEnvelope header)
	Fires a read of AMQP header events into the previous handler in the engine pipeline for further processing.

void	FireRead (SaslEnvelope envelope)
	Fires a read of SASL performative envelope events into the previous handler in the engine pipeline for further processing.

void	FireRead (IncomingAmqpEnvelope envelope)
	Fires a read of AMQP performative envelope events into the previous handler in the engine pipeline for further processing.

void	FireWrite (OutgoingAmqpEnvelope envelope)
	Fires a write of the given AMQP performative envelope which should be passed along the engine pipeline for processing.

void	FireWrite (SaslEnvelope envelope)
	Fires a write of the given SASL performative envelope which should be passed along the engine pipeline for processing.

void	FireWrite (HeaderEnvelope envelope)
	Fires a write of the given AMQP Header envelope which should be passed along the engine pipeline for processing.

void	FireWrite (IProtonBuffer buffer, Action ioComplete)
	Fires a write of the given proton buffer into the engine pipeline for processing and provides an action delegate which should be invoked when the IO has written the bytes fully.

Properties
IEngineHandler	Handler `[get]`
	Access the engine handler that this context is assigned to.

IEngine	Engine `[get]`
	Access the engine instance where this context and its handler are assigned.

string	Name `[get]`
	Access the name that was given to the handler assigned to this context.

Detailed Description

Context object that is provided to the engine handler APIs to allow for forwarding of events to the next handler or other updates.

Member Function Documentation

◆ FireEngineStarting()

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireEngineStarting ( )

Fires the engine starting event into the next handler in the engine pipeline.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireEngineStateChanged()

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireEngineStateChanged ( )

Fires the engine state changed event into the next handler in the EnginePipeline chain. The state change events occur after the engine starting event and generally signify that the engine has been shutdown normally.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireFailed()

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireFailed ( EngineFailedException ex )

Fires the engine failed event into the next handler in the {engine pipeline chain.

Parameters

ex	The exception that triggered the failure

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireRead() [1/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead ( HeaderEnvelope header )

Fires a read of AMQP header events into the previous handler in the engine pipeline for further processing.

Parameters

header

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireRead() [2/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead ( IncomingAmqpEnvelope envelope )

Fires a read of AMQP performative envelope events into the previous handler in the engine pipeline for further processing.

Parameters

envelope The incoming envelope that was read.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireRead() [3/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead ( IProtonBuffer buffer )

Fires a read event into the previous handler in the engine pipeline for further processing or dispatch to the next in line.

Parameters

buffer The buffer containing the bytes read

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireRead() [4/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead ( SaslEnvelope envelope )

Fires a read of SASL performative envelope events into the previous handler in the engine pipeline for further processing.

Parameters

envelope The incoming envelope that was read.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireWrite() [1/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite ( HeaderEnvelope envelope )

Fires a write of the given AMQP Header envelope which should be passed along the engine pipeline for processing.

Parameters

envelope The outgoing envelope that should be written.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireWrite() [2/4]

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

Fires a write of the given proton buffer into the engine pipeline for processing and provides an action delegate which should be invoked when the IO has written the bytes fully.

Parameters

buffer	The buffer that should be written to the IO layer
ioComplete	The completion action to invoke when the IO is done

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireWrite() [3/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite ( OutgoingAmqpEnvelope envelope )

Fires a write of the given AMQP performative envelope which should be passed along the engine pipeline for processing.

Parameters

envelope The outgoing envelope that should be written.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ FireWrite() [4/4]

void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite ( SaslEnvelope envelope )

Fires a write of the given SASL performative envelope which should be passed along the engine pipeline for processing.

Parameters

envelope The outgoing envelope that should be written.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

Property Documentation

◆ Engine

IEngine Apache.Qpid.Proton.Engine.IEngineHandlerContext.Engine

get

Access the engine instance where this context and its handler are assigned.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ Handler

IEngineHandler Apache.Qpid.Proton.Engine.IEngineHandlerContext.Handler

get

Access the engine handler that this context is assigned to.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

◆ Name

string Apache.Qpid.Proton.Engine.IEngineHandlerContext.Name

get

Access the name that was given to the handler assigned to this context.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.

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

src/Proton/Engine/IEngineHandlerContext.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ FireEngineStarting()

◆ FireEngineStateChanged()

◆ FireFailed()

◆ FireRead() [1/4]

◆ FireRead() [2/4]

◆ FireRead() [3/4]

◆ FireRead() [4/4]

◆ FireWrite() [1/4]

◆ FireWrite() [2/4]

◆ FireWrite() [3/4]

◆ FireWrite() [4/4]

Property Documentation

◆ Engine

◆ Handler

◆ Name