hu.icellmobilsoft.coffee.module.redisstream.config.IStreamGroupConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coffee-module-redisstream Show documentation
There is a newer version: 2.8.0
Show newest version
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * 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.
 * #L%
 */
package hu.icellmobilsoft.coffee.module.redisstream.config;

import java.util.Optional;

import hu.icellmobilsoft.coffee.dto.exception.BaseException;
import hu.icellmobilsoft.coffee.module.redisstream.annotation.RedisStreamConsumer;

/**
 * Redis stream group configuration interface
 * 
 * @author imre.scheffer
 * @since 1.3.0
 */
public interface IStreamGroupConfig {

    /**
     * See https://redis.io/commands/xreadgroup and https://redis.io/commands/xread BLOCK option
     * 
     * @return timeout on stream read in millis. Waiting on stream until this time for new message or return null
     * @throws BaseException
     *             Exception on read properties
     */
    Long getStreamReadTimeoutMillis() throws BaseException;

    /**
     * Max elements in stream, oldest will be removed. See https://redis.io/commands/xadd MAXLEN parameter. 

     * 

     * This parameter has higher priority than {@link #getProducerTTL()}, if both setted, this parameter is applied and {@link #getProducerTTL()}
     * ignored.
     * 
     * @return Max elements in stream
     * @throws BaseException
     *             Exception on read properties
     */
    Optional getProducerMaxLen() throws BaseException;

    /**
     * Millisec TTL. When a new entry is produced, all old entries are deleted which have identifier time older than (sysdate - millisecond). See
     * https://redis.io/commands/xadd MINID parameter. 

     * 

     * The parameter {@link #getProducerMaxLen()} has higher priority, if both setted, this parameter is ignored.
     * 
     * @return millisec ttl
     * @throws BaseException
     *             Exception on read properties
     */
    Optional getProducerTTL() throws BaseException;

    /**
     * How many threads start to listening on stream group. This value override {@link RedisStreamConsumer#consumerThreadsCount()}
     * 
     * @return threads count
     * @throws BaseException
     *             Exception on read properties
     */
    Optional getConsumerThreadsCount() throws BaseException;

    /**
     * How many times to try again if an exception occurs in the consumer process. This value override {@link RedisStreamConsumer#retryCount()}
     * 
     * @return retry process count
     * @throws BaseException
     *             Exception on read properties
     */
    Optional getRetryCount() throws BaseException;

    /**
     * Enable/Disable any part of stream function for any reason. This is only for project logic, no have direct use-case in coffee
     * 
     * @return true - enabled, default
     * @throws BaseException
     *             if any exception occurs
     */
    boolean isEnabled() throws BaseException;
}