org.springframework.data.redis.connection.Subscription Maven / Gradle / Ivy
/*
* Copyright 2011-2018 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.data.redis.connection;
import java.util.Collection;
/**
* Subscription for Redis channels. Just like the underlying {@link RedisConnection}, it should not be used by multiple
* threads. Note that once a subscription died, it cannot accept any more subscriptions.
*
* @author Costin Leau
* @author Christoph Strobl
*/
public interface Subscription {
/**
* Adds the given channels to the current subscription.
*
* @param channels channel names. Must not be empty.
*/
void subscribe(byte[]... channels) throws RedisInvalidSubscriptionException;
/**
* Adds the given channel patterns to the current subscription.
*
* @param patterns channel patterns. Must not be empty.
*/
void pSubscribe(byte[]... patterns) throws RedisInvalidSubscriptionException;
/**
* Cancels the current subscription for all channels given by name.
*/
void unsubscribe();
/**
* Cancels the current subscription for all given channels.
*
* @param channels channel names. Must not be empty.
*/
void unsubscribe(byte[]... channels);
/**
* Cancels the subscription for all channels matched by patterns.
*/
void pUnsubscribe();
/**
* Cancels the subscription for all channels matching the given patterns.
*
* @param patterns must not be empty.
*/
void pUnsubscribe(byte[]... patterns);
/**
* Returns the (named) channels for this subscription.
*
* @return collection of named channels
*/
Collection getChannels();
/**
* Returns the channel patters for this subscription.
*
* @return collection of channel patterns
*/
Collection getPatterns();
/**
* Returns the listener used for this subscription.
*
* @return the listener used for this subscription.
*/
MessageListener getListener();
/**
* Indicates whether this subscription is still 'alive' or not.
*
* @return true if the subscription still applies, false otherwise.
*/
boolean isAlive();
/**
* Shutdown the subscription and free any resources held.
*
* @since 1.8.12
*/
void close();
}