com.hivemq.spi.callback.events.OnUnsubscribeCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-spi Show documentation

The Service Provider Interfaces for developing HiveMQ plugins.

There is a newer version: 3.4.4

/*
 * Copyright 2014 dc-square 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.spi.callback.events;

import com.hivemq.spi.callback.AsynchronousCallback;
import com.hivemq.spi.message.UNSUBSCRIBE;
import com.hivemq.spi.security.ClientData;

/**
 * A callback which gets called when an UNSUBSCRIBE MQTT message arrives.
 *
 * @author Dominik Obermaier
 * @since 1.4
 */
public interface OnUnsubscribeCallback extends AsynchronousCallback {


    /**
     * Gets called when an UNSUBSCRIBE MQTT message arrives
     *
     * @param message    the {@link UNSUBSCRIBE} message
     * @param clientData information about the client
     */
    void onUnsubscribe(UNSUBSCRIBE message, ClientData clientData);
}