NodeSocketTransport
Defined in: protocol/src/node-socket-transport.ts:16
Transport for one framed data-plane connection.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NodeSocketTransport(
_socket):NodeSocketTransport
Defined in: protocol/src/node-socket-transport.ts:19
Parameters
Section titled “Parameters”_socket
Section titled “_socket”Socket
Returns
Section titled “Returns”NodeSocketTransport
Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: protocol/src/node-socket-transport.ts:50
Tear the connection down and reject any pending backpressure waits.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”pause()
Section titled “pause()”pause():
void
Defined in: protocol/src/node-socket-transport.ts:42
Pause inbound data (receive-side backpressure).
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”resume()
Section titled “resume()”resume():
void
Defined in: protocol/src/node-socket-transport.ts:46
Resume inbound data.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”writeFrame()
Section titled “writeFrame()”writeFrame(
header,payload):Promise<void>
Defined in: protocol/src/node-socket-transport.ts:31
Write header+payload as one frame.
Write BEFORE await to prevent deadlock: the buffers are handed to the socket synchronously (the header buffer is owned by the caller and never reused, so no defensive copy is needed), and only then do we wait out any backpressure.
Parameters
Section titled “Parameters”header
Section titled “header”Buffer
payload
Section titled “payload”Buffer
Returns
Section titled “Returns”Promise<void>