# 排他サブスクライブ

排他サブスクライブは、EMQXがサポートする拡張されたMQTT機能です。これはトピックに対して相互排他的なサブスクライブを可能にします。つまり、同時に1つのサブスクライバーのみがトピックをサブスクライブでき、現在のサブスクライバーがサブスクライブを解除するまで、他のサブスクライバーは該当トピックをサブスクライブできません。

サブスクライブを排他にするには、トピックの先頭にプレフィックスを追加する必要があります。以下の表は例を示しています。

| 例 | プレフィックス | 実際のトピック名 |
| --------------- | ----------- | ------------ |
| $exclusive/t/1 | $exclusive/ | t/1 |

クライアント**A**が`$exclusive/t/1`をサブスクライブすると、**A**が`$exclusive/t/1`のサブスクライブを解除するまで、他のクライアントは`$exclusive/t/1`をサブスクライブできません。

::: tip

排他サブスクライブは必ず`$exclusive/`で始まる必要があります。上記の例では、他のクライアントは`t/1`を使って正常にサブスクライブすることは可能です。

:::

## 設定ファイルで排他サブスクライブを有効化する

排他サブスクライブはデフォルトで無効化されています。設定ファイルで以下のように設定することで、この機能を有効化できます。

```bash
mqtt.exclusive_subscription.enable = true
```

## MQTTX Desktopで排他サブスクライブを試す

::: tip 前提条件

- [MQTTX Desktop](./publish-and-subscribe.md#mqttx-desktop)を使った基本的なパブリッシュおよびサブスクライブ操作ができること
- 排他サブスクライブが有効化されていること

:::

1. EMQXとMQTTX Desktopを起動します。**New Connection**をクリックして、パブリッシャーとしてクライアント接続を作成します。

   - **Name**欄に`Demo`と入力します。
   - **Host**欄にローカルホスト`127.0.0.1`を入力します（このデモの例として）。
   - 他の設定はデフォルトのままにして、**Connect**をクリックします。

   ::: tip

   MQTT接続の作成方法の詳細は[MQTTX Desktop](./publish-and-subscribe.md#mqttx-desktop)をご参照ください。

   :::

   <img src="./assets/Configure-new-connection-general.png" alt="新しい接続の一般設定" style="zoom:35%;" />

2. さらに2つのMQTT接続を作成し、それぞれ`Subscriber1`と`Subscriber2`と設定します。

3. **Connections**ペインで`Subscriber1`の接続を選択し、**New Subscription**ボタンをクリックしてサブスクライブを作成します。**Topic**のテキストボックスに`$exclusive/t/1`と入力し、このトピックをサブスクライブします。**Confirm**をクリックします。

   <img src="./assets/subscribe-exclusive-topic.png" alt="排他トピックのサブスクライブ" style="zoom:35%;" />

4. **Connections**ペインで`Subscriber2`の接続を選択し、同様に**New Subscription**ボタンをクリックしてサブスクライブを作成します。**Topic**に`$exclusive/t/1`と入力しサブスクライブを試みます。**Confirm**をクリックします。

   - エラーメッセージが表示されます。

   <img src="./assets/fail-to-exclusive-subscription.png" alt="排他サブスクライブ失敗" style="zoom:35%;" />

## MQTTX CLIで排他サブスクライブを試す

::: tip 前提条件

- [MQTTX CLI](./publish-and-subscribe.md#mqttx-cli)を使った基本的なパブリッシュおよびサブスクライブ操作ができること
- 排他サブスクライブが有効化されていること

:::

1. 以下のコマンドで排他サブスクライブを行います。

   ```bash
   mqttx sub -t "$exclusive/t/1"
   ```

2. ステップ1のコマンドを再度実行して、トピック`$exclusive/t/1`への別のサブスクライブを試みます。以下のように返されます。

   ```bash
   subscription negated to t/2 with code 135
   ```

   排他サブスクライブのエラーコード一覧：

   | コード | 理由                                                    |
   | ---- | --------------------------------------------------------- |
   | 0x8F | 排他サブスクライブが有効化されていない状態で`$exclusive/`を使用した。 |
   | 0x97 | すでに他のクライアントがこのトピックをサブスクライブしている。          |