Class StartupMessage

java.lang.Object

io.r2dbc.postgresql.message.frontend.StartupMessage

All Implemented Interfaces:

FrontendMessage

public final class StartupMessage
extends Object
implements FrontendMessage

The StartupMessage message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartupMessage.ParameterWriter	Writer interface to expose startup parameters.
static interface	StartupMessage.StartupParameterProvider	Interface that provides startup parameters into a StartupMessage.ParameterWriter.

Nested classes/interfaces inherited from interface FrontendMessage

FrontendMessage.DirectEncoder

Constructor Summary

Constructors

Constructor	Description
StartupMessage(@Nullable String database, String username, StartupMessage.StartupParameterProvider parameterProvider)	Create a new message.

Method Summary

Modifier and Type	Method	Description
Publisher<io.netty.buffer.ByteBuf>	encode(io.netty.buffer.ByteBufAllocator byteBufAllocator)	Encode a message into a ByteBuf.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StartupMessage

public StartupMessage(@Nullable String database,
 String username,
 StartupMessage.StartupParameterProvider parameterProvider)

Create a new message.

Parameters:

database - the database to connect to. Defaults to the username.

username - the database username to connect as

parameterProvider - the provider providing database connection options

Throws:

IllegalArgumentException - if applicationName or username is null

Method Details

encode

public Publisher<io.netty.buffer.ByteBuf> encode(io.netty.buffer.ByteBufAllocator byteBufAllocator)

Description copied from interface: FrontendMessage

Encode a message into a ByteBuf.

Specified by:

encode in interface FrontendMessage

Parameters:

byteBufAllocator - the byteBufAllocator to use to get a ByteBuf to write into

Returns:

a Publisher that produces the ByteBuf containing the encoded message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object