Package com.rabbitmq.client.impl.nio

Class FrameBuilder

java.lang.Object

com.rabbitmq.client.impl.nio.FrameBuilder

Direct Known Subclasses:

SslEngineFrameBuilder

public class FrameBuilder
extends Object

Class to create AMQP frames from a ReadableByteChannel. Supports partial frames: a frame can be read in several attempts from the NioLoop. This can happen when the channel won't read any more bytes in the middle of a frame building. The state of the outstanding frame is saved up, and the builder will start where it left off when the NioLoop comes back to this connection. This class is not thread safe.

Since:

4.4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final ByteBuffer	applicationBuffer
protected final ReadableByteChannel	channel

Constructor Summary

Constructors

Constructor	Description
FrameBuilder(ReadableByteChannel channel, ByteBuffer buffer, int maxPayloadSize)

Method Summary

Modifier and Type	Method	Description
boolean	isUnderflowHandlingEnabled()
Frame	readFrame()	Read a frame from the network.
protected boolean	somethingToRead()	Tells whether there's something to read in the application buffer or not.

Methods inherited from class java.lang.Object

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

Field Details

channel

protected final ReadableByteChannel channel

applicationBuffer

protected final ByteBuffer applicationBuffer

Constructor Details

FrameBuilder

public FrameBuilder(ReadableByteChannel channel,
 ByteBuffer buffer,
 int maxPayloadSize)

Method Details

readFrame

public Frame readFrame()
                throws IOException

Read a frame from the network. This method returns null f a frame could not have been fully built from the network. The client must then retry later (typically when the channel notifies it has something to read).

Returns:

a complete frame or null if a frame couldn't have been fully built

Throws:

IOException

See Also:

• Frame.readFrom(DataInputStream, int)

somethingToRead

protected boolean somethingToRead()
                           throws IOException

Tells whether there's something to read in the application buffer or not. Tries to read from the network if necessary.

Returns:

true if there's something to read in the application buffer

Throws:

IOException

isUnderflowHandlingEnabled

public boolean isUnderflowHandlingEnabled()