driver/io.github.octaviusframework.driver.io/PgStream

PgStream

internal class PgStream(val host: String, val port: Int, val loginTimeoutSecs: Int = 10, notificationBufferCapacity: Int = 256, val noticeHandler: NoticeHandler? = null, val sslConfiguration: SslConfiguration? = null, val cancelSignalTimeoutSecs: Int = 10) : AutoCloseable

Represents a connection stream to a PostgreSQL database. Handles reading and writing of PostgreSQL wire protocol messages.

Parameters

notificationBufferCapacity

Capacity of the buffer for asynchronous notifications.

Constructors

PgStream

constructor(host: String, port: Int, loginTimeoutSecs: Int = 10, notificationBufferCapacity: Int = 256, noticeHandler: NoticeHandler? = null, sslConfiguration: SslConfiguration? = null, cancelSignalTimeoutSecs: Int = 10)

Types

Companion

object Companion

Properties

activeCopy

var activeCopy: CopyOperation?

The transfer that last held this connection in copy mode, live or spent.

cancelSignalTimeoutSecs

val cancelSignalTimeoutSecs: Int

Seconds allowed for a cancel request sent on this connection's behalf, covering both its connect and its reads. Carried here for the same reason.

copyInProgress

val copyInProgress: Boolean

True while a COPY operation holds the connection in copy mode.

exchangeInProgress

var exchangeInProgress: Boolean

True while a statement is being executed on this connection, from the first message sent until the exchange is fully drained.

host

val host: String

The hostname or IP address of the PostgreSQL server.

inputStream

var inputStream: PgInputStream

isBroken

var isBroken: Boolean

isSecure

val isSecure: Boolean

Whether the connection ended up encrypted, whatever sslmode asked for.

lock

val lock: ReentrantLock

loginTimeoutSecs

val loginTimeoutSecs: Int

Timeout in seconds for the initial connection and login process.

maxCachedRowSize

var maxCachedRowSize: Int

networkTimeout

var networkTimeout: Int

The socket's read timeout, in milliseconds, with 0 meaning no limit.

noticeHandler

val noticeHandler: NoticeHandler?

notifications

val notifications: SharedFlow<PgNotification>

outputStream

var outputStream: PgOutputStream

parameters

val parameters: MutableMap<String, String>

peerCertificate

val peerCertificate: X509Certificate?

The certificate the server presented during the TLS handshake, or null on a plaintext connection and on the rare TLS connection where the peer never authenticated itself.

port

val port: Int

The port number of the PostgreSQL server.

processId

var processId: Int

secretKey

var secretKey: ByteArray

sslConfiguration

val sslConfiguration: SslConfiguration?

The SSL settings this connection was established with, kept so that a second connection opened on its behalf - a cancel request - can be given the same treatment.

startupComplete

var startupComplete: Boolean

False until the startup handshake reaches its first ReadyForQuery.

transactionStatus

var transactionStatus: Char

The transaction status the server reported on its last ReadyForQuery: I outside a transaction block, T inside one, E inside one that has failed.

Functions

awaitServerClose

fun awaitServerClose()

Blocks until the server closes this connection, discarding anything it sends beforehand.

beginExchange

fun beginExchange()

Marks the start of an exchange, refusing to begin one while another is already running. Every call must be paired with endExchange in a finally.

checkAvailable

fun checkAvailable()

Guards any operation that needs the protocol stream to itself.

open override fun close()

Closes the connection stream, sending a Terminate message if the socket is still open.

dropSocket

fun dropSocket()

Closes the socket without the Terminate that close sends first.

endExchange

fun endExchange()

Marks the end of an exchange.

flush

fun flush()

Flushes the underlying output stream, forcing any buffered bytes to be written out.

pollMessage

fun pollMessage(): BackendMessage?

Attempts to receive a backend message if one is immediately available or within the timeout. Returns null if no message is available (e.g. timeout reached while polling).

receiveMessage

fun receiveMessage(): BackendMessage

Receives a single backend message synchronously, blocking until data is available.

sendMessage

fun sendMessage(msg: FrontendMessage)

Sends a frontend message to the PostgreSQL server.

upgradeToSSL

fun upgradeToSSL(host: String, port: Int, config: SslConfiguration)

Upgrades the current connection to use SSL/TLS.