com.hivemq.mqtt.message.publish.Mqtt5PUBLISH Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation
HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5
The newest version!
/*
 * Copyright 2019-present HiveMQ GmbH
 *
 * 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 com.hivemq.mqtt.message.publish;

import com.google.common.primitives.ImmutableIntArray;
import com.hivemq.codec.encoder.mqtt5.Mqtt5PayloadFormatIndicator;
import com.hivemq.mqtt.message.Message;
import com.hivemq.mqtt.message.QoS;
import com.hivemq.mqtt.message.mqtt5.Mqtt5UserProperties;

/**
 * @since 4.0.0
 */
public interface Mqtt5PUBLISH extends Message {

    /**
     * @return the hivemq id of the publish message
     */
    String getHivemqId();

    /**
     * @return the unique id of the publish message
     */
    String getUniqueId();

    /**
     * @return the pulish id of the publish message
     */
    long getPublishId();

    /**
     * @return the payload of the publish message
     */
    byte[] getPayload();

    /**
     * @return the topic of the publish message
     */
    String getTopic();

    /**
     * @return the duplicate delivery flag of the publish message
     */
    boolean isDuplicateDelivery();

    /**
     * @return the retain flag of the publish message
     */
    boolean isRetain();

    /**
     * @return the message expiry interval (old ttl) of the publish message in seconds
     */
    long getMessageExpiryInterval();

    /**
     * @return the quality of service of the publish message
     */
    QoS getQoS();

    /**
     * @return the timestamp of the publish message
     */
    long getTimestamp();

    /**
     * @return the packet identifier of the publish message
     */
    int getPacketIdentifier();

    /**
     * dereferences the payload of the publish message
     */
    void setPayload(byte[] payload);

    /**
     * @return the payload format indicator of the publish message
     */
    Mqtt5PayloadFormatIndicator getPayloadFormatIndicator();

    /**
     * @return the content type of the publish message
     */
    String getContentType();

    /**
     * @return the response topic of the publish message
     */
    String getResponseTopic();

    /**
     * @return the correlation data of the publish message
     */
    byte[] getCorrelationData();

    /**
     * @return the is new topic alias flag of the publish message
     */
    boolean isNewTopicAlias();

    /**
     * @return the subscription identifiers of the publish message
     */
    ImmutableIntArray getSubscriptionIdentifiers();

    /**
     * @return the content type of the publish message
     */
    Mqtt5UserProperties getUserProperties();
}