PGPacketSocket | WebHare Platform SDK

Class PGPacketSocket

Connects to a PostgreSQL server over a socket, and provides methods to read and write packets. Use curPacket to access the last read packet.

Index

Constructors

Properties

Methods

close readPacket readSingleByte switchToTLS write

Constructors

constructor

new PGPacketSocket(socket: Socket): PGPacketSocket
Parameters
- socket: Socket
Returns PGPacketSocket
- Defined in jssdk/postgrease/src/socket.ts:51

Properties

curPacket

curPacket: {
    buffer: UndocumentedBuffer;
    code: number;
    dataLen: number;
    dataStart: number;
    dataview: DataView;
} = ...

Methods

close

close(): void
Returns void
- Defined in jssdk/postgrease/src/socket.ts:211

readPacket

readPacket(): void | Promise<void>
Reads a packet. Returns immediately when the next packet is available in curPacket, or a promise that resolves when the packet is available.

Returns void | Promise<void>
- Defined in jssdk/postgrease/src/socket.ts:183

readSingleByte

readSingleByte(): Promise<number>
Reads a single byte from the buffer. Should only be used in startup phase before reading packets.

Returns Promise<number>
- Defined in jssdk/postgrease/src/socket.ts:169

switchToTLS

switchToTLS(tlsOptions: ConnectionOptions): Promise<void>
Switches the current connection to use TLS with the given options.
Parameters
- tlsOptions: ConnectionOptions
Returns Promise<void>
- Defined in jssdk/postgrease/src/socket.ts:135

write

write(cb: (builder: RequestBuilder) => void): void
Calls a callback with a requestbuilder to build a request synchronously, and sends it immediately
Parameters
- cb: (builder: RequestBuilder) => void
Returns void
- Defined in jssdk/postgrease/src/socket.ts:156