com.hivemq.mqtt.services.InternalPublishService 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.services;

import com.google.common.util.concurrent.ListenableFuture;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.mqtt.handler.publish.PublishReturnCode;
import com.hivemq.mqtt.message.publish.PUBLISH;

import java.util.concurrent.ExecutorService;

/**
 * @author Christoph Schäbel
 */
public interface InternalPublishService {

    /**
     * Send a message to all clients and shared subscription groups which have an active subscription
     *
     * @param publish         the message to send
     * @param executorService the executor service in which all callbacks are executed
     * @param sender          client identifier of the client which sent the message
     */
    @NotNull ListenableFuture publish(
            @NotNull final PUBLISH publish,
            @NotNull final ExecutorService executorService,
            @Nullable final String sender);

}