com.rabbitmq.client.impl

Interface FrameHandler

All Superinterfaces:

NetworkConnection

All Known Implementing Classes:

SocketChannelFrameHandler, SocketFrameHandler

public interface FrameHandler
extends NetworkConnection

Interface to a frame handler.

Concurrency

Implementations must be thread-safe, and not allow frames to be interleaved, either while reading or writing.

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying data connection (complaint not permitted).
void	finishConnectionNegotiation() Callback to signal the end of the negotiation phase.
void	flush(WriteListener listener) Flush the underlying data connection and notify the listener when the write completes.
int	getTimeout() Get the underlying socket's read timeout in milliseconds.
void	initialize(AMQConnection connection)
default boolean	internalHearbeat()
Frame	readFrame() Read a Frame from the underlying data connection.
void	sendHeader() Send the initial connection header, thus kickstarting the AMQP protocol version negotiation process and putting the underlying connection in a state such that the next layer of startup can proceed.
void	setFrameMax(int frameMax) Cap inbound frame payloads, applied once frame_max is negotiated.
void	setTimeout(int timeoutMs) Set the underlying socket's read timeout in milliseconds, if applicable.
void	startProcessing() Start processing incoming frames, once the connection header has been sent.
void	writeFrame(Frame frame) Write a Frame to the underlying data connection.

Methods inherited from interface com.rabbitmq.client.impl.NetworkConnection

getAddress, getLocalAddress, getLocalPort, getPort

Method Detail

internalHearbeat

default boolean internalHearbeat()

setTimeout

void setTimeout(int timeoutMs)
         throws SocketException

Set the underlying socket's read timeout in milliseconds, if applicable.

Parameters:

timeoutMs - The timeout in milliseconds

Throws:

SocketException

getTimeout

int getTimeout()
        throws SocketException

Get the underlying socket's read timeout in milliseconds.

Returns:

The timeout in milliseconds

Throws:

SocketException

sendHeader

void sendHeader()
         throws IOException

Send the initial connection header, thus kickstarting the AMQP protocol version negotiation process and putting the underlying connection in a state such that the next layer of startup can proceed.

Throws:

IOException - if there is a problem accessing the connection

initialize

void initialize(AMQConnection connection)

startProcessing

void startProcessing()

Start processing incoming frames, once the connection header has been sent. Frame handlers that already read asynchronously (e.g. Netty, NIO) can ignore this, as reading may already be under way by the time initialize(AMQConnection) runs. Frame handlers with their own dedicated reader thread should wait for this call before starting it, so that thread does not race sendHeader() over the TLS handshake.

finishConnectionNegotiation

void finishConnectionNegotiation()

Callback to signal the end of the negotiation phase.

setFrameMax

void setFrameMax(int frameMax)

Cap inbound frame payloads, applied once frame_max is negotiated.

readFrame

Frame readFrame()
         throws IOException

Read a Frame from the underlying data connection.

Returns:

an incoming Frame, or null if there is none

Throws:

IOException - if there is a problem accessing the connection

SocketTimeoutException - if the underlying read times out

writeFrame

void writeFrame(Frame frame)
         throws IOException

Write a Frame to the underlying data connection.

Parameters:

frame - the Frame to transmit

Throws:

IOException - if there is a problem accessing the connection

flush

void flush(WriteListener listener)
    throws IOException

Flush the underlying data connection and notify the listener when the write completes. The default implementation flushes synchronously and calls the listener immediately.

Parameters:

listener - called when the flush completes, may be null

Throws:

IOException - if there is a problem accessing the connection

close

void close()

Close the underlying data connection (complaint not permitted).