nats.client.HandlerRegistration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nats-client Show documentation

A Java NATS client.

There is a newer version: 0.5.Beta4

/*
 *   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 nats.client;

/**
 * Provides a registration for a handler such as a {@link CompletionHandler} or {@link nats.client.MessageHandler}. This
 * registration is used to remove the handler from the list of handlers that will be invoked when the pending operation
 * completes.
 * 
 * For example, when using a {@link nats.client.Subscription}, you may add a {@link nats.client.MessageHandler} using the
 * {@link nats.client.Subscription#addMessageHandler(nats.client.MessageHandler)} method. This method returns an instance of
 * {@code HandlerRegistration}. When the {@link #remove()} method is invoked, the {@code MessageHandler} is removed
 * from the {@code Subscription} and will no longer be called when new messages arrive on the {@code Subscription}.
 *
 * @author Mike Heath 
 */
public interface HandlerRegistration {

	/**
	 * Removes the handler associated with this {@code HandlerRegistration}.
	 */
	void remove();

}