Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Dokumen ini mengklarifikasi arti REST API bidang data Web PubSub dalam konteks MQTT. Dokumentasi WEB PubSub REST API yang ada difokuskan pada protokol Web PubSub sendiri, yang dapat membuat aplikasinya ke MQTT tidak jelas.
Pemetaan istilah
Untuk memulai, biasakan diri Anda dengan istilah pemetaan antara Web PubSub dan MQTT. Jika Anda sudah terbiasa dengan istilah-istilah ini, Anda dapat melewati bagian ini.
| Istilah MQTT | Istilah Web PubSub yang sesuai | Hubungan |
|---|---|---|
| Server/MQTT Broker | Web PubSub Service | Layanan Web PubSub berfungsi sebagai broker MQTT untuk melayani koneksi MQTT. Harap dicatat bahwa kami biasanya menggunakan server istilah untuk merujuk ke server upstream alih-alih broker MQTT dalam dokumen. |
| Sesi | Connection | Koneksi di Web PubSub adalah konsep logis yang mewakili hubungan stateful antara klien dan layanan, dan satu Koneksi sesuai dengan satu Sesi. Biasanya kedua kata ini dapat dipertukarkan. |
| Berlangganan topik | Bergabung dengan grup | Kedua tindakan ini memiliki efek yang sama: klien akan menerima pesan dari topik atau grup tersebut. Nama topik adalah nama grup. |
| Menerbitkan pesan ke topik | Mengirim pesan ke grup | Kedua tindakan ini memiliki efek yang sama: klien yang berlangganan topik tersebut atau termasuk dalam grup tersebut akan menerima pesan |
| ID klien | ID Koneksi | ID Koneksi mengidentifikasi Koneksi ke Web PubSub. Kami menggunakan ID Klien sebagai ID Koneksi koneksi MQTT di Web PubSub. |
Pemetaan operasi
Untuk daftar komprehensif operasi yang tersedia, lihat referensi REST API.
Operasi REST API dikategorikan ke dalam grup berikut:
- Operasi pengiriman pesan
- Operasi manajemen langganan
- Operasi manajemen izin
- Operasi manajemen keberadaan
- Operasi pembuatan token klien
Masing-masing kategori ini didefinisikan di bawah ini.
Operasi pengiriman pesan
| Operasi REST API | Pengaruh pada MQTT |
|---|---|
| Kirim ke Grup | Koneksi MQTT yang berlangganan topik bernama dengan nama grup akan menerima pesan. |
| Kirim ke Semua Kirim ke Pengguna Kirim ke Koneksi |
Koneksi MQTT masing-masing akan menerima pesan dengan topik $webpubsub/server/messages. |
Pesan diterbitkan dengan QoS 1. QoS pesan yang diterima dapat diturunkan berdasarkan opsi langganan klien, mengikuti aturan penurunan MQTT standar.
Operasi manajemen langganan
| Operasi REST API | Pengaruh pada MQTT |
|---|---|
| Tambahkan Koneksi ke Grup Tambahkan Koneksi ke Grup |
Menambahkan langganan untuk koneksi yang ditentukan. |
| Tambahkan Pengguna ke Grup | Menambahkan langganan untuk semua koneksi pengguna yang ditentukan. |
| Hapus Koneksi dari Semua Grup Hapus Koneksi dari Grup Hapus Koneksi dari Grup Hapus Pengguna dari Semua Grup Hapus Pengguna dari Grup |
Menghapus satu atau semua langganan untuk koneksi atau pengguna yang ditentukan. |
Nama grup sesuai dengan filter topik MQTT. Saat menambahkan koneksi atau pengguna ke grup, opsi langganan MQTT default digunakan.
Operasi manajemen izin
Operasi ini mudah dalam konteks MQTT dan dengan demikian definisi diabaikan.
- Periksa Izin
- Beri Izin
- Cabut Izin
Operasi manajemen keberadaan
| Operasi REST API | Pengaruh pada MQTT |
|---|---|
| Koneksi Ada Grup Ada Pengguna Ada |
Memeriksa apakah ada sesi untuk koneksi, pengguna, atau grup yang ditentukan. Perhatikan bahwa ini berbeda dari memeriksa apakah koneksi saat ini sedang online. |
| Tutup Semua Koneksi Tutup Koneksi Grup Tutup Koneksi Pengguna |
Mengakhiri sesi yang ditentukan dan mengakhiri koneksi fisik yang sesuai. |
Operasi pembuatan token klien
| Operasi REST API | Pengaruh pada MQTT |
|---|---|
| Hasilkan Token Klien | Menghasilkan token koneksi dan URL untuk klien MQTT untuk terhubung. |
Harap dicatat bahwa dukungan MQTT tersedia mulai dari versi 2024-01-01REST API . Anda harus menentukan parameter clientType=MQTT kueri untuk klien MQTT.