org.redisson.api.StreamConsumer Maven / Gradle / Ivy

Go to download

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

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2

Show newest version

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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.redisson.api;

/**
 * Object containing details about Stream Consumer
 *
 * @author Nikita Koksharov
 *
 */
public class StreamConsumer {

    private final String name;
    private final int pending;
    private final long idleTime;
    private final long inactive;

    public StreamConsumer(String name, int pending, long idleTime, long inactive) {
        this.name = name;
        this.pending = pending;
        this.idleTime = idleTime;
        this.inactive = inactive;
    }

    /**
     * Returns amount of pending messages for this consumer
     *
     * @return amount of pending messages
     */
    public int getPending() {
        return pending;
    }

    /**
     * Returns name of this consumer
     *
     * @return name of consumer
     */
    public String getName() {
        return name;
    }

    /**
     * Returns idle time in milliseconds since which this consumer hasn't consumed messages
     *
     * @return idle time in milliseconds
     */
    public long getIdleTime() {
        return idleTime;
    }

    /**
     * Returns time in milliseconds since the last successful interaction of this consumer
     * 
     * Requires Redis 7.2.0 and higher.
     *
     * @return time in milliseconds
     */
    public long getInactive() {
        return inactive;
    }
}