driver/io.github.octaviusframework.driver.message.frontend

Package-level declarations

Types

internal class BindMessage(portalName: String, statementName: String, parameterCount: Int, parameterValues: ByteArray, parameterFormats: List<Int>, resultFormats: List<Int> = listOf(1), parameterValuesLength: Int = parameterValues.size) : FrontendMessage

Message sent to the backend to bind a prepared statement to a portal.

CancelRequestMessage

internal class CancelRequestMessage(processId: Int, secretKey: ByteArray) : FrontendMessage

Message sent by the frontend to cancel an ongoing request on another connection.

CloseMessage

internal class CloseMessage(targetType: Char, name: String) : FrontendMessage

Message sent to the backend to close a statement or portal.

DescribeMessage

internal class DescribeMessage(targetType: Char, name: String) : FrontendMessage

Message sent to the backend to describe a statement or portal.

ExecuteMessage

internal class ExecuteMessage(portalName: String, maxRows: Int = 0) : FrontendMessage

Message sent to the backend to execute a portal.

FlushMessage

internal class FlushMessage : FrontendMessage

Message sent to the backend to force it to flush its output buffer.

FrontendCopyDataMessage

internal class FrontendCopyDataMessage(data: ByteArray, offset: Int = 0, length: Int = data.size) : FrontendMessage

Sends data during a COPY IN operation.

FrontendCopyDoneMessage

internal class FrontendCopyDoneMessage : FrontendMessage

Indicates completion of a COPY IN operation from the frontend.

FrontendCopyFailMessage

internal class FrontendCopyFailMessage(errorMessage: String) : FrontendMessage

Fails a COPY IN operation from the frontend.

FrontendMessage

internal sealed interface FrontendMessage

Base interface for all messages sent to the PostgreSQL backend.

ParseMessage

internal class ParseMessage(statementName: String, query: String, parameterTypes: IntArray = IntArray(0)) : FrontendMessage

Message sent to the backend to parse a prepared statement.

PasswordMessage

internal class PasswordMessage(password: String) : FrontendMessage

The password itself, in the clear, in answer to an AuthenticationCleartextPassword request.

SASLInitialResponse

internal class SASLInitialResponse(mechanism: String, clientFirstMessage: String) : FrontendMessage

First client response in the SASL mechanism.

SASLResponse

internal class SASLResponse(clientFinalMessage: String) : FrontendMessage

Next client response in the SASL mechanism (usually sending client-final-message).

SimpleQueryMessage

internal class SimpleQueryMessage(query: String) : FrontendMessage

Message sent by the frontend to execute a simple, un-parameterized SQL query.

SSLRequestMessage

internal class SSLRequestMessage : FrontendMessage

Message sent by the frontend to request an SSL encrypted connection.

StartupMessage

internal class StartupMessage(parameters: Map<String, String>) : FrontendMessage

Initial message sent by the frontend to start a connection with the server.

SyncMessage

internal class SyncMessage : FrontendMessage

Message sent to the backend to synchronize the connection state and signal the end of a sequence of extended query messages.

TerminateMessage

internal class TerminateMessage : FrontendMessage

Connection termination message (Tag 'X').