Skip to main content

MqttCreditGate

@totemsdk/edge-mqtt

@totemsdk/edge-mqtt / MqttCreditGate

Interface: MqttCreditGate

Methods​

checkCredit()​

checkCredit(): Promise<MqttCreditDecision>

Returns​

Promise<MqttCreditDecision>

gatePublish()​

gatePublish(topic, payload, options?): Promise<EdgeOperationResult<unknown>>

Parameters​

topic​

string

payload​

string | Uint8Array<ArrayBufferLike>

options?​

MqttPublishOptions

Returns​

Promise<EdgeOperationResult<unknown>>

getUnpaidUsage()​

getUnpaidUsage(): string

Returns​

string

publishShutdownNotice()​

publishShutdownNotice(reason): Promise<void>

Parameters​

reason​

string

Returns​

Promise<void>

recordUsage()​

recordUsage(quantity): void

Record usage directly on the gate, accumulating toward the limit. Call this when not using an external usage meter via config.getUsage.

Parameters​

quantity​

string

Returns​

void