Interface MqttTransport

A transport-agnostic packet pipe used by the MQTT session.

Both the TCP (CoreSocket) and WebSocket transports implement this so the session encodes and decodes the same control packets over either. readPacket resolves the next complete packet or null at end of stream; writePacket sends one already-encoded packet.

Since

1.0.0

interface MqttTransport {
    close(): Promise<void>;
    readPacket(): Promise<DecodedPacket | null>;
    writePacket(bytes: Uint8Array): Promise<void>;
}

Index

Methods

close readPacket writePacket

Methods

close

close(): Promise<void>
Closes the underlying transport.

Returns Promise<void>
- Defined in src/mqtt/index.ts:89

readPacket

readPacket(): Promise<DecodedPacket | null>
Reads the next complete control packet, or null once the peer closes.

Returns Promise<DecodedPacket | null>
- Defined in src/mqtt/index.ts:85

writePacket

writePacket(bytes: Uint8Array): Promise<void>
Sends one encoded control packet.
Parameters
- bytes: Uint8Array
Returns Promise<void>
- Defined in src/mqtt/index.ts:87

Interface MqttTransport

Since

Index

Methods

Methods

close

Returns Promise<void>

readPacket

Returns Promise<DecodedPacket | null>

writePacket

Parameters

Returns Promise<void>

Settings

On This Page