io.vertx.mqtt.messages.MqttPubRelMessage 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

There is a newer version: 5.0.0.CR1

/*
 * 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.messages.codes.MqttPubRelReasonCode;
import io.vertx.mqtt.messages.impl.MqttPubRelMessageImpl;

/**
 * Represents an MQTT PUBREL message
 */
@VertxGen
public interface MqttPubRelMessage {

  /**
   * Create a concrete instance of a Vert.x pubrel message
   *
   * @param messageId message Id
   * @param code  return code from the pubrel
   * @param properties MQTT properties of the pubrel message
   * @return
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  static MqttPubRelMessage create(int messageId, MqttPubRelReasonCode code, MqttProperties properties) {
    return new MqttPubRelMessageImpl(messageId, code, properties);
  }

  @CacheReturn
  int messageId();

  /**
   * @return  reason code from the pubrel request
   */
  @CacheReturn
  MqttPubRelReasonCode code();

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