com.hivemq.mqtt.topic.SubscriptionFlag 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

There is a newer version: 2025.1

Show 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.topic;

import com.hivemq.util.Bytes;

public enum SubscriptionFlag {

    SHARED_SUBSCRIPTION(1),
    RETAIN_AS_PUBLISHED(2),
    NO_LOCAL(3);

    private final int flagIndex;

    SubscriptionFlag(final int flagIndex) {
        this.flagIndex = flagIndex;
    }

    public int getFlagIndex() {
        return flagIndex;
    }

    public static byte getDefaultFlags(
            final boolean isSharedSubscription, final boolean retainAsPublished, final boolean noLocal) {

        byte flags = Bytes.setBit((byte) 0, SHARED_SUBSCRIPTION.getFlagIndex(), isSharedSubscription);
        flags = Bytes.setBit(flags, RETAIN_AS_PUBLISHED.getFlagIndex(), retainAsPublished);
        return Bytes.setBit(flags, NO_LOCAL.getFlagIndex(), noLocal);
    }
}