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

Class ProtonFrameEncodingHandler

java.lang.Object

org.apache.qpid.protonj2.engine.impl.ProtonFrameEncodingHandler

All Implemented Interfaces:

EngineHandler

public class ProtonFrameEncodingHandler
extends Object
implements EngineHandler

Handler that encodes performatives into properly formed frames for IO

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	AMQP_FRAME_TYPE	Frame type indicator for AMQP protocol frames.
static final byte	SASL_FRAME_TYPE	Frame type indicator for SASL protocol frames.

Constructor Summary

Constructors

Constructor	Description
ProtonFrameEncodingHandler()

Method Summary

Modifier and Type	Method	Description
void	engineStarting(EngineHandlerContext context)	Called when the engine is started to allow handlers to prepare for use based on the configuration state at start of the engine.
void	handlerAdded(EngineHandlerContext context)	Called when the handler is successfully added to the EnginePipeline and will later be initialized before use.
void	handleWrite(EngineHandlerContext context, HeaderEnvelope envelope)	Handles write of AMQPHeader either by directly writing it to the output target or by converting it to bytes and firing a write using the ProtonBuffer based API in EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)
void	handleWrite(EngineHandlerContext context, OutgoingAMQPEnvelope envelope)	Handles write of AMQP performative envelope either by directly writing it to the output target or by converting it to bytes and firing a write using the ProtonBuffer based API in EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)
void	handleWrite(EngineHandlerContext context, SASLEnvelope envelope)	Handles write of SaslPerformative either by directly writing it to the output target or by converting it to bytes and firing a write using the ProtonBuffer based API in EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.protonj2.engine.EngineHandler

engineFailed, handleEngineStateChanged, handleRead, handleRead, handleRead, handleRead, handlerRemoved, handleWrite

Field Details

AMQP_FRAME_TYPE

public static final byte AMQP_FRAME_TYPE

Frame type indicator for AMQP protocol frames.

See Also:

• Constant Field Values

SASL_FRAME_TYPE

public static final byte SASL_FRAME_TYPE

Frame type indicator for SASL protocol frames.

See Also:

• Constant Field Values

Constructor Details

ProtonFrameEncodingHandler

public ProtonFrameEncodingHandler()

Method Details

handlerAdded

public void handlerAdded(EngineHandlerContext context)

Description copied from interface: EngineHandler

Called when the handler is successfully added to the EnginePipeline and will later be initialized before use.

Specified by:

handlerAdded in interface EngineHandler

Parameters:

context - The context that is assigned to this handler.

engineStarting

public void engineStarting(EngineHandlerContext context)

Description copied from interface: EngineHandler

Called when the engine is started to allow handlers to prepare for use based on the configuration state at start of the engine. A handler can fail the engine start by throwing an exception.

Specified by:

engineStarting in interface EngineHandler

Parameters:

context - The context for this handler which can be used to forward the event to the next handler

handleWrite

public void handleWrite(EngineHandlerContext context,
 HeaderEnvelope envelope)

Description copied from interface: EngineHandler

Handles write of AMQPHeader either by directly writing it to the output target or by converting it to bytes and firing a write using the ProtonBuffer based API in EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)

Specified by:

handleWrite in interface EngineHandler

Parameters:

context - The EngineHandlerContext associated with this EngineHandler instance.

envelope - The HeaderEnvelope instance to write.

handleWrite

public void handleWrite(EngineHandlerContext context,
 SASLEnvelope envelope)

Description copied from interface: EngineHandler

Handles write of SaslPerformative either by directly writing it to the output target or by converting it to bytes and firing a write using the ProtonBuffer based API in EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)

Specified by:

handleWrite in interface EngineHandler

Parameters:

context - The EngineHandlerContext associated with this EngineHandler instance.

envelope - The SASLEnvelope instance to write.

handleWrite

public void handleWrite(EngineHandlerContext context,
 OutgoingAMQPEnvelope envelope)

Description copied from interface: EngineHandler

Handles write of AMQP performative envelope either by directly writing it to the output target or by converting it to bytes and firing a write using the ProtonBuffer based API in EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)

Specified by:

handleWrite in interface EngineHandler

Parameters:

context - The EngineHandlerContext associated with this EngineHandler instance.

envelope - The OutgoingAMQPEnvelope instance to write.