TsgcWSPClient_MQTTMetodi › UnSubscribe

UnSubscribe Metodo

Rimuove una o più sottoscrizioni di argomenti attive dalla sessione MQTT corrente.

Overload

Overload 1

Sintassi

function UnSubscribe(const aTopic: string; aUnsubscribeProperties: TsgcWSMQTTUnsubscribe_Properties = nil) : Word;

Parametri

NomeTipoDescrizione
aTopicconst stringFiltro argomento esatto, corrispondente a una precedente chiamata Subscribe, da rimuovere.
aUnsubscribePropertiesTsgcWSMQTTUnsubscribe_PropertiesProprietà MQTT 5.0 facoltative (per esempio User Properties). Passi nil quando non sono richieste.

Valore restituito

Identificatore del pacchetto assegnato al pacchetto UNSUBSCRIBE; lo correli con OnMQTTUnSubscribe per leggere i reason code del broker. (Word)

Note

Sovraccarico a singolo argomento. Il filtro deve corrispondere a quello passato originariamente a Subscribe, inclusi i caratteri jolly, altrimenti il broker segnalerà un codice di motivo "No subscription existed". I messaggi in attesa già in transito potrebbero essere ancora consegnati dopo la chiamata.

Esempio

MQTT.UnSubscribe('sensors/+/temperature');

Sovraccarico 2

Sintassi

function UnSubscribe(aTopics: TsgcWSTopics): Word;

Parametri

NomeTipoDescrizione
aTopicsTsgcWSTopicsRaccolta di filtri di argomento da eliminare con un singolo pacchetto UNSUBSCRIBE.

Valore restituito

Identificatore del pacchetto del pacchetto UNSUBSCRIBE in batch. (Word)

Note

Overload batch utile quando un client che traccia molti filtri si disconnette, o quando una modifica di modalità forza il ricablaggio di diverse sottoscrizioni contemporaneamente. Ogni voce nella raccolta produce il proprio codice motivo nell'UNSUBACK del broker, segnalato tramite OnMQTTUnSubscribe.

Esempio

oTopics := TsgcWSTopics.Create;
try
  oTopics.Add('sensors/#');
  oTopics.Add('alerts/#');
  MQTT.UnSubscribe(oTopics);
finally
  oTopics.Free;
end;

Torna ai Metodi