Package org.apache.qpid.protonj2.engine.impl

Class ProtonEngineHandlerContext

java.lang.Object

org.apache.qpid.protonj2.engine.impl.ProtonEngineHandlerContext

All Implemented Interfaces:

EngineHandlerContext

public class ProtonEngineHandlerContext
extends Object
implements EngineHandlerContext

Context for a registered EngineHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	HANDLER_ALL_EVENTS	The context indicator for a handler that wants to be sent all read and write events.
static final int	HANDLER_READS	The context indicator for a handler that wants to be sent read events.
static final int	HANDLER_WRITES	The context indicator for a handler that wants to be sent write events.

Constructor Summary

Constructors

Constructor	Description
ProtonEngineHandlerContext(String name, Engine engine, EngineHandler handler)	Creates a new ProtonEngineHandlerContext with the given options.

Method Summary

Modifier and Type	Method	Description
Engine	engine()
void	fireEngineStarting()	Fires the engine starting event into the next handler in the EnginePipeline chain.
void	fireEngineStateChanged()	Fires the engine state changed event into the next handler in the EnginePipeline chain.
void	fireFailed(EngineFailedException failure)	Fires the Engine failed event into the next handler in the EnginePipeline chain.
void	fireRead(ProtonBuffer buffer)	Fires a read of ProtonBuffer events into the previous handler in the EnginePipeline for further processing.
void	fireRead(HeaderEnvelope header)	Fires a read of HeaderFrame events into the previous handler in the EnginePipeline for further processing.
void	fireRead(IncomingAMQPEnvelope envelope)	Fires a read of IncomingProtocolFrame events into the previous handler in the EnginePipeline for further processing.
void	fireRead(SASLEnvelope envelope)	Fires a read of SASL events into the previous handler in the EnginePipeline for further processing.
void	fireWrite(ProtonBuffer buffer, Runnable ioComplete)	Fires a write of ProtonBuffer events into the next handler in the EnginePipeline for further processing.
void	fireWrite(HeaderEnvelope envelope)	Fires a write of HeaderFrame events into the next handler in the EnginePipeline for further processing.
void	fireWrite(OutgoingAMQPEnvelope envelope)	Fires a write of OutgoingAMQPEnvelope events into the next handler in the EnginePipeline for further processing.
void	fireWrite(SASLEnvelope envelope)	Fires a write of SASLEnvelope events into the next handler in the EnginePipeline for further processing.
EngineHandler	handler()
int	interestMask()	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.
ProtonEngineHandlerContext	interestMask(int mask)	Sets the interest mask for this handler context which controls which events should be routed here during normal engine handler pipeline operations.
String	name()

Methods inherited from class java.lang.Object

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

Field Details

HANDLER_READS

public static final int HANDLER_READS

The context indicator for a handler that wants to be sent read events.

See Also:

• Constant Field Values

HANDLER_WRITES

public static final int HANDLER_WRITES

The context indicator for a handler that wants to be sent write events.

See Also:

• Constant Field Values

HANDLER_ALL_EVENTS

public static final int HANDLER_ALL_EVENTS

The context indicator for a handler that wants to be sent all read and write events.

See Also:

• Constant Field Values

Constructor Details

ProtonEngineHandlerContext

public ProtonEngineHandlerContext(String name,
 Engine engine,
 EngineHandler handler)

Creates a new ProtonEngineHandlerContext with the given options.

Parameters:

name - The name of this ProtonEngineHandlerContext.

engine - The engine that this context is assigned to.

handler - The EngineHandler that this EngineHandlerContext manages.

Method Details

handler

public EngineHandler handler()

Specified by:

handler in interface EngineHandlerContext

Returns:

the EngineHandler that is associated with the context.

name

public String name()

Specified by:

name in interface EngineHandlerContext

Returns:

the name that assigned to this EngineHandler when added to the EnginePipeline.

engine

public Engine engine()

Specified by:

engine in interface EngineHandlerContext

Returns:

the Engine where this handler is registered.

interestMask

public int interestMask()

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.

Returns:

the interest mask that should be used to determine if a handler should be signaled.

interestMask

public ProtonEngineHandlerContext interestMask(int mask)

Sets the interest mask for this handler context which controls which events should be routed here during normal engine handler pipeline operations.

Parameters:

mask - The interest mask for this EngineHandlerContext.

Returns:

this ProtonEngineHandlerContext instance.

fireEngineStarting

public void fireEngineStarting()

Description copied from interface: EngineHandlerContext

Fires the engine starting event into the next handler in the EnginePipeline chain.

Specified by:

fireEngineStarting in interface EngineHandlerContext

fireEngineStateChanged

public void fireEngineStateChanged()

Description copied from interface: EngineHandlerContext

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.

Specified by:

fireEngineStateChanged in interface EngineHandlerContext

fireFailed

public void fireFailed(EngineFailedException failure)

Description copied from interface: EngineHandlerContext

Fires the Engine failed event into the next handler in the EnginePipeline chain.

Specified by:

fireFailed in interface EngineHandlerContext

Parameters:

failure - The exception that describes the conditions under which the engine failed.

fireRead

public void fireRead(ProtonBuffer buffer)

Description copied from interface: EngineHandlerContext

Fires a read of ProtonBuffer events into the previous handler in the EnginePipeline for further processing.

Specified by:

fireRead in interface EngineHandlerContext

Parameters:

buffer - The ProtonBuffer that carries the bytes read.

fireRead

public void fireRead(HeaderEnvelope header)

Description copied from interface: EngineHandlerContext

Fires a read of HeaderFrame events into the previous handler in the EnginePipeline for further processing.

Specified by:

fireRead in interface EngineHandlerContext

Parameters:

header - The HeaderEnvelope that carries the header bytes read.

fireRead

public void fireRead(SASLEnvelope envelope)

Description copied from interface: EngineHandlerContext

Fires a read of SASL events into the previous handler in the EnginePipeline for further processing.

Specified by:

fireRead in interface EngineHandlerContext

Parameters:

envelope - The SASLEnvelope that carries the SASL performative read.

fireRead

public void fireRead(IncomingAMQPEnvelope envelope)

Description copied from interface: EngineHandlerContext

Fires a read of IncomingProtocolFrame events into the previous handler in the EnginePipeline for further processing.

Specified by:

fireRead in interface EngineHandlerContext

Parameters:

envelope - The IncomingAMQPEnvelope that carries the AMQP performative read.

fireWrite

public void fireWrite(OutgoingAMQPEnvelope envelope)

Description copied from interface: EngineHandlerContext

Fires a write of OutgoingAMQPEnvelope events into the next handler in the EnginePipeline for further processing.

Specified by:

fireWrite in interface EngineHandlerContext

Parameters:

envelope - The OutgoingAMQPEnvelope that carries the AMQP performative being written.

fireWrite

public void fireWrite(SASLEnvelope envelope)

Description copied from interface: EngineHandlerContext

Fires a write of SASLEnvelope events into the next handler in the EnginePipeline for further processing.

Specified by:

fireWrite in interface EngineHandlerContext

Parameters:

envelope - The SASLEnvelope that carries the SASL performative being written.

fireWrite

public void fireWrite(HeaderEnvelope envelope)

Description copied from interface: EngineHandlerContext

Fires a write of HeaderFrame events into the next handler in the EnginePipeline for further processing.

Specified by:

fireWrite in interface EngineHandlerContext

Parameters:

envelope - The HeaderEnvelope that carries the AMQP Header being written.

fireWrite

public void fireWrite(ProtonBuffer buffer,
 Runnable ioComplete)

Description copied from interface: EngineHandlerContext

Fires a write of ProtonBuffer events into the next handler in the EnginePipeline for further processing.

Specified by:

fireWrite in interface EngineHandlerContext

Parameters:

buffer - The ProtonBuffer that carries the bytes being written.

ioComplete - An optional Runnable callback that is signaled when the I/O completes successfully.