io.asyncer.r2dbc.mysql.message.client

Interface ClientMessage

All Known Subinterfaces:

HandshakeResponse, SslRequest, SubsequenceClientMessage

All Known Implementing Classes:

AuthResponse, ExitMessage, InitDbMessage, LocalInfileResponse, PingMessage, PreparedCloseMessage, PreparedExecuteMessage, PreparedFetchMessage, PreparedLargeDataMessage, PreparedResetMessage, PreparedTextQueryMessage, PrepareQueryMessage, TextQueryMessage

public interface ClientMessage

A message sent from a MySQL client to a MySQL server.

Method Summary

Modifier and Type	Method and Description
CorePublisher<io.netty.buffer.ByteBuf>	encode(io.netty.buffer.ByteBufAllocator allocator, ConnectionContext context) Encode a message into ByteBufs.
default boolean	isCumulative() Returns whether the encoded buffers can be cumulated to maximize the payload size.
default boolean	isSequenceReset() Returns whether the sequence should be reset before encoding this message.

Method Detail

isSequenceReset

default boolean isSequenceReset()

Returns whether the sequence should be reset before encoding this message.

Returns:

true if the sequence should be reset.

isCumulative

default boolean isCumulative()

Returns whether the encoded buffers can be cumulated to maximize the payload size.

Returns:

true if can be cumulated.

encode

CorePublisher<io.netty.buffer.ByteBuf> encode(io.netty.buffer.ByteBufAllocator allocator,
                                              ConnectionContext context)

Encode a message into ByteBufs.

Parameters:

allocator - the ByteBufAllocator that use to get ByteBuf to write into.

context - current MySQL connection context.

Returns:

a Flux that's produces the encoded ByteBufs.

Throws:

IllegalArgumentException - if allocator or context is null.