org.proton.plug.handler.impl

Class ProtonHandlerImpl

java.lang.Object

org.proton.plug.context.ProtonInitializable

org.proton.plug.handler.impl.ProtonHandlerImpl

All Implemented Interfaces:

ProtonHandler

public class ProtonHandlerImpl
extends ProtonInitializable
implements ProtonHandler

Clebert Suconic

Nested Class Summary

Nested classes/interfaces inherited from interface org.proton.plug.handler.ProtonHandler

ProtonHandler.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dataReceived
protected boolean	receivedFirstPacket

Constructor Summary

Constructors

Constructor and Description
ProtonHandlerImpl(Executor dispatchExecutor)

Method Summary

Modifier and Type	Method and Description
ProtonHandler	addEventHandler(EventHandler handler) Add an event handler to the chain
int	capacity() It returns true if the transport connection has any capacity available
boolean	checkDataReceived() To be used at your discretion to verify if the client was active since you last checked it can be used to implement server TTL cleanup and verifications
protected void	checkServerSASL()
void	close() It will close the connection and flush events
void	createClientSasl(ClientSASL clientSASL)
void	createServerSASL(ServerSASL[] handlers) To be used on server connections.
void	flush() It will process the transport and cause events to be called
org.apache.qpid.proton.engine.Connection	getConnection()
long	getCreationTime() Return the creation time of the handler
Object	getLock() Get the object used to lock transport, connection and events operations
SASLResult	getSASLResult() To return the SASL Mechanism that was successful with the connection.
org.apache.qpid.proton.engine.Transport	getTransport()
void	inputBuffer(io.netty.buffer.ByteBuf buffer) The input on the Handler.
io.netty.buffer.ByteBuf	outputBuffer() it will return pending bytes you have on the Transport after you are done with it you must call ProtonHandler.outputDone(int)
void	outputDone(int bytes) To be called after you used the outputBuffer
long	tick(boolean firstTick)

Methods inherited from class org.proton.plug.context.ProtonInitializable

afterInit, initialise, isInitialized, waitWithTimeout

Methods inherited from class java.lang.Object

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

Field Detail

dataReceived

protected volatile boolean dataReceived

receivedFirstPacket

protected boolean receivedFirstPacket

Constructor Detail

ProtonHandlerImpl

public ProtonHandlerImpl(Executor dispatchExecutor)

Method Detail

tick

public long tick(boolean firstTick)

Specified by:

tick in interface ProtonHandler

capacity

public int capacity()

Description copied from interface: ProtonHandler

It returns true if the transport connection has any capacity available

Specified by:

capacity in interface ProtonHandler

Returns:

getLock

public Object getLock()

Description copied from interface: ProtonHandler

Get the object used to lock transport, connection and events operations

Specified by:

getLock in interface ProtonHandler

Returns:

getTransport

public org.apache.qpid.proton.engine.Transport getTransport()

Specified by:

getTransport in interface ProtonHandler

getConnection

public org.apache.qpid.proton.engine.Connection getConnection()

Specified by:

getConnection in interface ProtonHandler

addEventHandler

public ProtonHandler addEventHandler(EventHandler handler)

Description copied from interface: ProtonHandler

Add an event handler to the chain

Specified by:

addEventHandler in interface ProtonHandler

Returns:

createServerSASL

public void createServerSASL(ServerSASL[] handlers)

Description copied from interface: ProtonHandler

To be used on server connections. To define SASL integration.

Specified by:

createServerSASL in interface ProtonHandler

getSASLResult

public SASLResult getSASLResult()

Description copied from interface: ProtonHandler

To return the SASL Mechanism that was successful with the connection. This should contain any state such as user and password

Specified by:

getSASLResult in interface ProtonHandler

Returns:

inputBuffer

public void inputBuffer(io.netty.buffer.ByteBuf buffer)

Description copied from interface: ProtonHandler

The input on the Handler. Notice that buffer will be positioned up to where we needed

Specified by:

inputBuffer in interface ProtonHandler

checkDataReceived

public boolean checkDataReceived()

Description copied from interface: ProtonHandler

To be used at your discretion to verify if the client was active since you last checked it can be used to implement server TTL cleanup and verifications

Specified by:

checkDataReceived in interface ProtonHandler

Returns:

getCreationTime

public long getCreationTime()

Description copied from interface: ProtonHandler

Return the creation time of the handler

Specified by:

getCreationTime in interface ProtonHandler

Returns:

outputDone

public void outputDone(int bytes)

Description copied from interface: ProtonHandler

To be called after you used the outputBuffer

Specified by:

outputDone in interface ProtonHandler

Parameters:

bytes - number of bytes you used already on the output

outputBuffer

public io.netty.buffer.ByteBuf outputBuffer()

Description copied from interface: ProtonHandler

it will return pending bytes you have on the Transport after you are done with it you must call ProtonHandler.outputDone(int)

Specified by:

outputBuffer in interface ProtonHandler

Returns:

createClientSasl

public void createClientSasl(ClientSASL clientSASL)

Specified by:

createClientSasl in interface ProtonHandler

flush

public void flush()

Description copied from interface: ProtonHandler

It will process the transport and cause events to be called

Specified by:

flush in interface ProtonHandler

close

public void close()

Description copied from interface: ProtonHandler

It will close the connection and flush events

Specified by:

close in interface ProtonHandler

checkServerSASL

protected void checkServerSASL()