Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext Class Reference

A context object that is assigned to each new engine handler that is inserted into an engine handler pipeline. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext:

Public Member Functions
	ProtonEngineHandlerContext (string name, IEngine engine, IEngineHandler handler)
virtual void	FireEngineStarting ()
	Fires the engine starting event into the next handler in the engine pipeline.
virtual 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.
virtual void	FireFailed (EngineFailedException ex)
	Fires the engine failed event into the next handler in the {engine pipeline chain.
virtual 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.
virtual void	FireRead (HeaderEnvelope header)
	Fires a read of AMQP header events into the previous handler in the engine pipeline for further processing.
virtual void	FireRead (SaslEnvelope envelope)
	Fires a read of SASL performative envelope events into the previous handler in the engine pipeline for further processing.
virtual void	FireRead (IncomingAmqpEnvelope envelope)
	Fires a read of AMQP performative envelope events into the previous handler in the engine pipeline for further processing.
virtual void	FireWrite (OutgoingAmqpEnvelope envelope)
	Fires a write of the given AMQP performative envelope which should be passed along the engine pipeline for processing.
virtual void	FireWrite (SaslEnvelope envelope)
	Fires a write of the given SASL performative envelope which should be passed along the engine pipeline for processing.
virtual void	FireWrite (HeaderEnvelope envelope)
	Fires a write of the given AMQP Header envelope which should be passed along the engine pipeline for processing.
virtual 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.

Static Public Attributes
static readonly uint	HANDLER_READS = 1 << 1
	The context indicator for a handler that wants to be sent read events.
static readonly uint	HANDLER_WRITES = 1 << 2
	The context indicator for a handler that wants to be sent write events.
static readonly uint	HANDLER_ALL_EVENTS = HANDLER_READS | HANDLER_WRITES
	The context indicator for a handler that wants to be sent all read and write events.

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.
uint	InterestMask [get, set]
	Allows a handler to indicate if it wants to be notified of a Engine Handler events for specific operations or opt into all engine handler events. By opting out of the events that the handler does not process the call chain can be reduced when processing engine events.
Properties inherited from Apache.Qpid.Proton.Engine.IEngineHandlerContext

Detailed Description

A context object that is assigned to each new engine handler that is inserted into an engine handler pipeline.

Member Function Documentation

FireEngineStarting()

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireEngineStarting ( )

inlinevirtual

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

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireEngineStateChanged()

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireEngineStateChanged ( )

inlinevirtual

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.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireFailed()

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireFailed ( EngineFailedException  ex )

inlinevirtual

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

Parameters

ex	The exception that triggered the failure

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireRead() [1/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireRead ( HeaderEnvelope  header )

inlinevirtual

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

Parameters

header

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireRead() [2/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireRead ( IncomingAmqpEnvelope  envelope )

inlinevirtual

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.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireRead() [3/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireRead ( IProtonBuffer  buffer )

inlinevirtual

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

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireRead() [4/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireRead ( SaslEnvelope  envelope )

inlinevirtual

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.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireWrite() [1/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireWrite ( HeaderEnvelope  envelope )

inlinevirtual

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.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireWrite() [2/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireWrite ( IProtonBuffer  buffer, Action  ioComplete  )

inlinevirtual

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

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireWrite() [3/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireWrite ( OutgoingAmqpEnvelope  envelope )

inlinevirtual

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.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

FireWrite() [4/4]

virtual void Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.FireWrite ( SaslEnvelope  envelope )

inlinevirtual

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.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

Property Documentation

Engine

IEngine Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.Engine

get

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

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

Handler

IEngineHandler Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.Handler

get

Access the engine handler that this context is assigned to.

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

Name

string Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext.Name

get

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

Implements Apache.Qpid.Proton.Engine.IEngineHandlerContext.

---

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

• src/Proton/Engine/Implementation/ProtonEngineHandlerContext.cs