cool.mqtt.hooks.MqttSubscription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mqtt.cool-hook-java-api Show documentation

The Java API for developing MQTT.Cool Hooks

The newest version!

package cool.mqtt.hooks;

/**
 * An abstraction of the SUBSCRIBE Control Packet, sent by the client and passed to the
 * Hook, before being encoded and finally submitted to the target MQTT broker.
 */
public interface MqttSubscription {

  /**
   * Gets the topic filter indicating one or more topics to which the client subscribe.
   *
   * @return the topic filter
   */
  String getTopicFilter();

  /**
   * Gets the maximum Quality Of Service level which the target MQTT broker is allowed to send
   * Application Messages.
   *
   * @return the maximum Quality Of Service level
   */
  QoS getQos();

}