HandlerRegistration.java

/*
 *   Copyright (c) 2013 Mike Heath.  All rights reserved.
 *
 *   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 cloudeventbus.client;

/**
 * Used to remove a registered {@link MessageHandler} instance from a {@link Subscription} instance.
 *
 * @author Mike Heath <elcapo@gmail.com>
 */
public interface HandlerRegistration {

	/**
	 * Removes the registered {@link MessageHandler} instance from the {@link Subscription} instance. The registered
	 * {@code MessageHandler} will no longer be invoked when the subscription receives messages. Nothing will happen
	 * if this method is invoked more than once.
	 */
	void remove();

}