Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler Class Referencesealed

Frame logger for outgoing AMQP and SASL performatives and Headers. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler:
Apache.Qpid.Proton.Engine.IEngineHandler

Public Member Functions

void HandlerAdded (IEngineHandlerContext context)
 Called when the handler is successfully added to the engine pipeline and will later be initialized before use.
 
void HandleRead (IEngineHandlerContext context, HeaderEnvelope envelope)
 Handle the receipt of an incoming AMQP Header or SASL Header based on the current state of this handler.
 
void HandleRead (IEngineHandlerContext context, SaslEnvelope envelope)
 Handle the receipt of an incoming SASL performative envelope based on the current state of this handler.
 
void HandleRead (IEngineHandlerContext context, IncomingAmqpEnvelope envelope)
 Handle the receipt of an incoming AMQP performative envelope based on the current state of this handler.
 
void HandleWrite (IEngineHandlerContext context, HeaderEnvelope envelope)
 Handles write of AMQP Header either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API.
 
void HandleWrite (IEngineHandlerContext context, OutgoingAmqpEnvelope envelope)
 Handles write of AMQP performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API.
 
void HandleWrite (IEngineHandlerContext context, SaslEnvelope envelope)
 Handles write of SASL performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API.
 
- Public Member Functions inherited from Apache.Qpid.Proton.Engine.IEngineHandler
void HandlerRemoved (IEngineHandlerContext context)
 Called when the handler is successfully removed from the engine pipeline and will not be invoked again or ever.
 
void EngineStarting (IEngineHandlerContext context)
 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.
 
void HandleEngineStateChanged (IEngineHandlerContext context)
 Called when the engine state has changed and handlers may need to update their internal state to respond to the change or prompt some new work based on the change, e.g state changes from not writable to writable.
 
void EngineFailed (IEngineHandlerContext context, EngineFailedException failure)
 Called when the engine has transitioned to a failed state and cannot process any additional input or output. The handler can free and resources used for normal operations at this point as the engine is now considered shutdown.
 
void HandleRead (IEngineHandlerContext context, IProtonBuffer buffer)
 Handle the read of new incoming bytes from a remote sender. The handler should generally decode these bytes into an AMQP Performative or SASL Performative based on the current state of the connection and the handler in question.
 
void HandleWrite (IEngineHandlerContext context, IProtonBuffer buffer, Action ioComplete)
 

Detailed Description

Frame logger for outgoing AMQP and SASL performatives and Headers.

Member Function Documentation

◆ HandlerAdded()

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandlerAdded ( IEngineHandlerContext  context)
inline

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

Parameters
contextThe handler context that is assigned to this handler

Implements Apache.Qpid.Proton.Engine.IEngineHandler.

◆ HandleRead() [1/3]

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandleRead ( IEngineHandlerContext  context,
HeaderEnvelope  envelope 
)
inline

Handle the receipt of an incoming AMQP Header or SASL Header based on the current state of this handler.

Parameters
contextThe handler context that is assigned to this handler
envelopeThe envelope that was read

Implements Apache.Qpid.Proton.Engine.IEngineHandler.

◆ HandleRead() [2/3]

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandleRead ( IEngineHandlerContext  context,
IncomingAmqpEnvelope  envelope 
)
inline

Handle the receipt of an incoming AMQP performative envelope based on the current state of this handler.

Parameters
contextThe handler context that is assigned to this handler
envelopeThe envelope that was read

Implements Apache.Qpid.Proton.Engine.IEngineHandler.

◆ HandleRead() [3/3]

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandleRead ( IEngineHandlerContext  context,
SaslEnvelope  envelope 
)
inline

Handle the receipt of an incoming SASL performative envelope based on the current state of this handler.

Parameters
contextThe handler context that is assigned to this handler
envelopeThe envelope that was read

Implements Apache.Qpid.Proton.Engine.IEngineHandler.

◆ HandleWrite() [1/3]

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandleWrite ( IEngineHandlerContext  context,
HeaderEnvelope  envelope 
)
inline

Handles write of AMQP Header either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API.

Parameters
contextThe handler context that is assigned to this handler
envelopeThe envelope that is to be written

Implements Apache.Qpid.Proton.Engine.IEngineHandler.

◆ HandleWrite() [2/3]

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandleWrite ( IEngineHandlerContext  context,
OutgoingAmqpEnvelope  envelope 
)
inline

Handles write of AMQP performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API.

Parameters
contextThe handler context that is assigned to this handler
envelopeThe envelope that is to be written

Implements Apache.Qpid.Proton.Engine.IEngineHandler.

◆ HandleWrite() [3/3]

void Apache.Qpid.Proton.Engine.Implementation.ProtonFrameLoggingHandler.HandleWrite ( IEngineHandlerContext  context,
SaslEnvelope  envelope 
)
inline

Handles write of SASL performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API.

Parameters
contextThe handler context that is assigned to this handler
envelopeThe envelope that is to be written

Implements Apache.Qpid.Proton.Engine.IEngineHandler.


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