io.vertx.mqtt.messages.MqttSubscribeMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-mqtt Show documentation
Vert.x MQTT reactive client and server
The newest version!
/*
 * Copyright 2016 Red Hat 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 io.vertx.mqtt.messages;

import io.netty.handler.codec.mqtt.MqttProperties;
import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.mqtt.MqttTopicSubscription;
import io.vertx.mqtt.messages.impl.MqttSubscribeMessageImpl;

import java.util.List;

/**
 * Represents an MQTT SUBSCRIBE message
 */
@VertxGen
public interface MqttSubscribeMessage extends MqttMessage {

  /**
   * Create a concrete instance of a Vert.x subscribe message
   *
   * @param messageId          message identifier
   * @param topicSubscriptions list with topics and related quality of service levels (from Netty)
   * @return Vert.x subscribe message
   */
  @GenIgnore
  static MqttSubscribeMessage create(int messageId, List topicSubscriptions) {

    return new MqttSubscribeMessageImpl(messageId, topicSubscriptions, MqttProperties.NO_PROPERTIES);
  }

  /**
   * Create a concrete instance of a Vert.x subscribe message
   *
   * @param messageId          message identifier
   * @param topicSubscriptions list with topics and related quality of service levels (from Netty)
   * @param properties MQTT message properties
   * @return Vert.x subscribe message
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  static MqttSubscribeMessage create(int messageId, List topicSubscriptions, MqttProperties properties) {
    return new MqttSubscribeMessageImpl(messageId, topicSubscriptions, properties);
  }


  /**
   * @return  List with topics and related quolity of service levels
   */
  @CacheReturn
  List topicSubscriptions();

  /**
   * @return MQTT properties
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @CacheReturn
  MqttProperties properties();
}