swim.mqtt.MqttSubscription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swim-mqtt Show documentation
MQTT packet model and wire protocol codec that incrementally decodes and encodes MQTT streams without intermediate buffering
The newest version!
// Copyright 2015-2024 Nstream, inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package swim.mqtt;

import swim.codec.Debug;
import swim.codec.Encoder;
import swim.codec.Format;
import swim.codec.Output;
import swim.codec.OutputBuffer;
import swim.util.Murmur3;

public final class MqttSubscription implements Debug {

  final String topicName;
  final int flags;

  MqttSubscription(String topicName, int flags) {
    this.topicName = topicName;
    this.flags = flags;
  }

  public String topicName() {
    return this.topicName;
  }

  public MqttSubscription topicName(String topicName) {
    return new MqttSubscription(topicName, this.flags);
  }

  public int flags() {
    return this.flags;
  }

  public MqttQoS qos() {
    return MqttQoS.from(this.flags & MqttSubscription.QOS_MASK);
  }

  public MqttSubscription qos(MqttQoS qos) {
    final int flags = this.flags & ~MqttSubscription.QOS_MASK | qos.code;
    return new MqttSubscription(this.topicName, flags);
  }

  public int mqttSize(MqttEncoder mqtt) {
    return mqtt.sizeOfSubscription(this);
  }

  public Encoder mqttEncoder(MqttEncoder mqtt) {
    return mqtt.subscriptionEncoder(this);
  }

  public Encoder mqttEncoder() {
    return this.mqttEncoder(Mqtt.standardEncoder());
  }

  public Encoder encodeMqtt(OutputBuffer output, MqttEncoder mqtt) {
    return mqtt.encodeSubscription(output, this);
  }

  public Encoder encodeMqtt(OutputBuffer output) {
    return this.encodeMqtt(output, Mqtt.standardEncoder());
  }

  @Override
  public boolean equals(Object other) {
    if (this == other) {
      return true;
    } else if (other instanceof MqttSubscription) {
      final MqttSubscription that = (MqttSubscription) other;
      return this.topicName.equals(that.topicName) && this.flags == that.flags;
    }
    return false;
  }

  private static int hashSeed;

  @Override
  public int hashCode() {
    if (MqttSubscription.hashSeed == 0) {
      MqttSubscription.hashSeed = Murmur3.seed(MqttSubscription.class);
    }
    return Murmur3.mash(Murmur3.mix(Murmur3.mix(MqttSubscription.hashSeed,
        this.topicName.hashCode()), this.flags));
  }

  @Override
  public  Output debug(Output output) {
    output = output.write("MqttSubscription").write('.').write("create").write('(').debug(this.topicName);
    if ((this.flags & MqttSubscription.QOS_MASK) != 0) {
      output = output.write(", ").debug(this.qos());
    }
    output = output.write(')');
    return output;
  }

  @Override
  public String toString() {
    return Format.debug(this);
  }

  static final int QOS_MASK = 0x03;

  public static MqttSubscription create(String topicName, int flags) {
    return new MqttSubscription(topicName, flags);
  }

  public static MqttSubscription create(String topicName, MqttQoS qos) {
    return new MqttSubscription(topicName, qos.code);
  }

  public static MqttSubscription create(String topicName) {
    return new MqttSubscription(topicName, 0);
  }

}