ConsumerStopAction.java

/*
 * Copyright 2015-2016 the original author or authors.
 *
 * 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 org.springframework.integration.mqtt.core;

/**
 * Action to take regarding subscrptions when consumer stops.
 *
 * @author Gary Russell
 * @since 4.2.3
 *
 */
public enum ConsumerStopAction {

	/**
	 * Never unsubscribe.
	 */
	UNSUBSCRIBE_NEVER,

	/**
	 * Always unsubscribe.
	 */
	UNSUBSCRIBE_ALWAYS,

	/**
	 * Unsubscribe if clean session is true.
	 */
	UNSUBSCRIBE_CLEAN

}