org.apache.qpid.proton.engine.impl

Class TransportImpl

java.lang.Object

org.apache.qpid.proton.engine.impl.EndpointImpl

org.apache.qpid.proton.engine.impl.TransportImpl

All Implemented Interfaces:

FrameBody.FrameBodyHandler<java.lang.Integer>, Endpoint, FrameHandler, ProtonJEndpoint, ProtonJTransport, Transport

public class TransportImpl
extends EndpointImpl
implements ProtonJTransport, FrameBody.FrameBodyHandler<java.lang.Integer>, FrameHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.proton.engine.Transport

Transport.Factory

Field Summary

Fields inherited from interface org.apache.qpid.proton.engine.Transport

DEFAULT_MAX_FRAME_SIZE, END_OF_STREAM, MIN_MAX_FRAME_SIZE, SESSION_WINDOW, TRACE_DRV, TRACE_FRM, TRACE_OFF, TRACE_RAW

Constructor Summary

Constructors

Constructor and Description
TransportImpl() Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a EngineFactory instead

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(Connection conn)
int	capacity()
void	close_head()
void	close_tail()
void	closed(TransportException error)
int	getChannelMax()
ErrorCondition	getCondition()
protected ConnectionImpl	getConnectionImpl()
java.nio.ByteBuffer	getInputBuffer() Get a buffer that can be used to write input data into the transport.
int	getMaxFrameSize() Get the maximum frame size for the transport
java.nio.ByteBuffer	getOutputBuffer() Get a read-only byte buffer containing the transport's pending output.
ProtocolTracer	getProtocolTracer()
int	getRemoteChannelMax()
int	getRemoteMaxFrameSize()
void	handleAttach(Attach attach, Binary payload, java.lang.Integer channel)
void	handleBegin(Begin begin, Binary payload, java.lang.Integer channel)
void	handleClose(Close close, Binary payload, java.lang.Integer channel)
void	handleDetach(Detach detach, Binary payload, java.lang.Integer channel)
void	handleDisposition(Disposition disposition, Binary payload, java.lang.Integer channel)
void	handleEnd(End end, Binary payload, java.lang.Integer channel)
void	handleFlow(Flow flow, Binary payload, java.lang.Integer channel)
boolean	handleFrame(TransportFrame frame)
void	handleOpen(Open open, Binary payload, java.lang.Integer channel)
void	handleTransfer(Transfer transfer, Binary payload, java.lang.Integer channel)
java.nio.ByteBuffer	head()
int	input(byte[] bytes, int offset, int length) Processes the provided input.
boolean	isClosed()
boolean	isHandlingFrames() Returns whether I am currently able to handle frames.
TransportResult	oldApiCheckStateBeforeInput(int inputLength) This method is public as it is used by Python layer.
int	output(byte[] bytes, int offset, int size) Has the transport produce up to size bytes placing the result into dest beginning at position offset.
void	outputConsumed() Informs the transport that the output buffer returned by Transport.getOutputBuffer() is finished with, allowing implementation-dependent steps to be performed such as reclaiming buffer space.
int	pending()
void	pop(int bytes)
void	process()
TransportResult	processInput() Tell the transport to process the data written to the input buffer.
Sasl	sasl() Signal the transport to expect SASL frames used to establish a SASL layer prior to performing the AMQP protocol version negotiation.
void	setChannelMax(int n)
void	setFrameHandler(FrameHandler frameHandler) Override the default frame handler.
void	setMaxFrameSize(int maxFrameSize) TODO propagate the new value to _outputProcessor etc
void	setProtocolTracer(ProtocolTracer protocolTracer)
Ssl	ssl(SslDomain sslDomain) As per Transport.ssl(SslDomain, SslPeerDetails) but no attempt is made to resume a previous SSL session.
Ssl	ssl(SslDomain sslDomain, SslPeerDetails sslPeerDetails) Wrap this transport's output and input to apply SSL encryption and decryption respectively.
java.nio.ByteBuffer	tail()
java.lang.String	toString()
void	trace(int levels)
void	unbind()
boolean	writeInto(java.nio.ByteBuffer outputBuffer) Writes my pending output bytes into outputBuffer.

Methods inherited from class org.apache.qpid.proton.engine.impl.EndpointImpl

close, free, getContext, getLocalState, getRemoteCondition, getRemoteState, open, setCondition, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.proton.engine.Endpoint

close, free, getContext, getLocalState, getRemoteCondition, getRemoteState, open, setCondition, setContext

Constructor Detail

TransportImpl

@Deprecated
public TransportImpl()

Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a EngineFactory instead

Method Detail

trace

public void trace(int levels)

Specified by:

trace in interface Transport

getMaxFrameSize

public int getMaxFrameSize()

Description copied from interface: Transport

Get the maximum frame size for the transport

Specified by:

getMaxFrameSize in interface Transport

Returns:

the maximum frame size

getRemoteMaxFrameSize

public int getRemoteMaxFrameSize()

Specified by:

getRemoteMaxFrameSize in interface Transport

setMaxFrameSize

public void setMaxFrameSize(int maxFrameSize)

TODO propagate the new value to _outputProcessor etc

Specified by:

setMaxFrameSize in interface Transport

getChannelMax

public int getChannelMax()

Specified by:

getChannelMax in interface Transport

setChannelMax

public void setChannelMax(int n)

Specified by:

setChannelMax in interface Transport

getRemoteChannelMax

public int getRemoteChannelMax()

Specified by:

getRemoteChannelMax in interface Transport

getCondition

public ErrorCondition getCondition()

Specified by:

getCondition in interface Endpoint

Specified by:

getCondition in interface Transport

Overrides:

getCondition in class EndpointImpl

Returns:

the local endpoint error, or null if there is none

bind

public void bind(Connection conn)

Specified by:

bind in interface Transport

unbind

public void unbind()

Specified by:

unbind in interface Transport

input

public int input(byte[] bytes,
        int offset,
        int length)

Description copied from interface: Transport

Processes the provided input.

Specified by:

input in interface Transport

Parameters:

bytes - input bytes for consumption

offset - the offset within bytes where input begins

length - the number of bytes available for input

Returns:

the number of bytes consumed

oldApiCheckStateBeforeInput

public TransportResult oldApiCheckStateBeforeInput(int inputLength)

This method is public as it is used by Python layer.

See Also:

Transport.input(byte[], int, int)

output

public int output(byte[] bytes,
         int offset,
         int size)

Description copied from interface: Transport

Has the transport produce up to size bytes placing the result into dest beginning at position offset.

Specified by:

output in interface Transport

Parameters:

bytes - array for output bytes

offset - the offset within bytes where output begins

size - the maximum number of bytes to be output

Returns:

the number of bytes written

writeInto

public boolean writeInto(java.nio.ByteBuffer outputBuffer)

Writes my pending output bytes into outputBuffer. Does not subsequently flip it. Returns true on end of stream.

sasl

public Sasl sasl()

Description copied from interface: Transport

Signal the transport to expect SASL frames used to establish a SASL layer prior to performing the AMQP protocol version negotiation. This must first be performed before the transport is used for processing. Subsequent invocations will return the same Sasl object.

Specified by:

sasl in interface Transport

ssl

public Ssl ssl(SslDomain sslDomain,
      SslPeerDetails sslPeerDetails)

Wrap this transport's output and input to apply SSL encryption and decryption respectively. This method is expected to be called at most once. A subsequent invocation will return the same Ssl object, regardless of the parameters supplied.

Note that sslDomain must implement ProtonSslEngineProvider. This is not possible enforce at the API level because ProtonSslEngineProvider is not part of the public Proton API.

Specified by:

ssl in interface Transport

Parameters:

sslDomain - the SSL settings to use

sslPeerDetails - may be null, in which case SSL session resume will not be attempted

Returns:

an Ssl object representing the SSL session.

ssl

public Ssl ssl(SslDomain sslDomain)

Description copied from interface: Transport

As per Transport.ssl(SslDomain, SslPeerDetails) but no attempt is made to resume a previous SSL session.

Specified by:

ssl in interface Transport

getConnectionImpl

protected ConnectionImpl getConnectionImpl()

Specified by:

getConnectionImpl in class EndpointImpl

handleOpen

public void handleOpen(Open open,
              Binary payload,
              java.lang.Integer channel)

Specified by:

handleOpen in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleBegin

public void handleBegin(Begin begin,
               Binary payload,
               java.lang.Integer channel)

Specified by:

handleBegin in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleAttach

public void handleAttach(Attach attach,
                Binary payload,
                java.lang.Integer channel)

Specified by:

handleAttach in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleFlow

public void handleFlow(Flow flow,
              Binary payload,
              java.lang.Integer channel)

Specified by:

handleFlow in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleTransfer

public void handleTransfer(Transfer transfer,
                  Binary payload,
                  java.lang.Integer channel)

Specified by:

handleTransfer in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleDisposition

public void handleDisposition(Disposition disposition,
                     Binary payload,
                     java.lang.Integer channel)

Specified by:

handleDisposition in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleDetach

public void handleDetach(Detach detach,
                Binary payload,
                java.lang.Integer channel)

Specified by:

handleDetach in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleEnd

public void handleEnd(End end,
             Binary payload,
             java.lang.Integer channel)

Specified by:

handleEnd in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleClose

public void handleClose(Close close,
               Binary payload,
               java.lang.Integer channel)

Specified by:

handleClose in interface FrameBody.FrameBodyHandler<java.lang.Integer>

handleFrame

public boolean handleFrame(TransportFrame frame)

Specified by:

handleFrame in interface FrameHandler

See Also:

FrameHandler.isHandlingFrames()

closed

public void closed(TransportException error)

Specified by:

closed in interface FrameHandler

isHandlingFrames

public boolean isHandlingFrames()

Description copied from interface: FrameHandler

Returns whether I am currently able to handle frames. MUST be checked before calling FrameHandler.handleFrame(TransportFrame).

Specified by:

isHandlingFrames in interface FrameHandler

getProtocolTracer

public ProtocolTracer getProtocolTracer()

Specified by:

getProtocolTracer in interface ProtonJTransport

setProtocolTracer

public void setProtocolTracer(ProtocolTracer protocolTracer)

Specified by:

setProtocolTracer in interface ProtonJTransport

getInputBuffer

public java.nio.ByteBuffer getInputBuffer()

Description copied from interface: Transport

Get a buffer that can be used to write input data into the transport. Once the client has finished putting into the input buffer, Transport.processInput() must be called. Successive calls to this method are not guaranteed to return the same object. Once Transport.processInput() is called the buffer must not be used.

Specified by:

getInputBuffer in interface Transport

processInput

public TransportResult processInput()

Description copied from interface: Transport

Tell the transport to process the data written to the input buffer. If the returned result indicates failure, the transport will not accept any more input. Specifically, any subsequent Transport.processInput() calls on this object will throw an exception.

Specified by:

processInput in interface Transport

Returns:

the result of processing the data, which indicates success or failure.

See Also:

Transport.getInputBuffer()

getOutputBuffer

public java.nio.ByteBuffer getOutputBuffer()

Description copied from interface: Transport

Get a read-only byte buffer containing the transport's pending output. Once the client has finished getting from the output buffer, Transport.outputConsumed() must be called. Successive calls to this method are not guaranteed to return the same object. Once Transport.outputConsumed() is called the buffer must not be used. If the transport's state changes AFTER calling this method, this will not be reflected in the output buffer.

Specified by:

getOutputBuffer in interface Transport

outputConsumed

public void outputConsumed()

Description copied from interface: Transport

Informs the transport that the output buffer returned by Transport.getOutputBuffer() is finished with, allowing implementation-dependent steps to be performed such as reclaiming buffer space.

Specified by:

outputConsumed in interface Transport

capacity

public int capacity()

Specified by:

capacity in interface Transport

tail

public java.nio.ByteBuffer tail()

Specified by:

tail in interface Transport

process

public void process()
             throws TransportException

Specified by:

process in interface Transport

Throws:

TransportException

close_tail

public void close_tail()

Specified by:

close_tail in interface Transport

pending

public int pending()

Specified by:

pending in interface Transport

head

public java.nio.ByteBuffer head()

Specified by:

head in interface Transport

pop

public void pop(int bytes)

Specified by:

pop in interface Transport

close_head

public void close_head()

Specified by:

close_head in interface Transport

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Transport

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setFrameHandler

public void setFrameHandler(FrameHandler frameHandler)

Override the default frame handler. Must be called before the transport starts being used (e.g. getInputBuffer(), getOutputBuffer(), ssl(SslDomain) etc).