Interface RScoredSortedSetAsync<V>

    • Method Detail

      • pollLastFromAnyAsync

        RFuture<V> pollLastFromAnyAsync​(long timeout,
                                        TimeUnit unit,
                                        String... queueNames)
        Removes and returns first available tail element of any sorted set, waiting up to the specified wait time if necessary for an element to become available in any of defined sorted sets including this one.

        Requires Redis 5.0.0 and higher.

        Parameters:
        queueNames - - names of queue
        timeout - how long to wait before giving up, in units of unit
        unit - a TimeUnit determining how to interpret the timeout parameter
        Returns:
        the tail element, or null if all sorted sets are empty
      • pollFirstFromAnyAsync

        RFuture<V> pollFirstFromAnyAsync​(long timeout,
                                         TimeUnit unit,
                                         String... queueNames)
        Removes and returns first available head element of any sorted set, waiting up to the specified wait time if necessary for an element to become available in any of defined sorted sets including this one.

        Requires Redis 5.0.0 and higher.

        Parameters:
        queueNames - - names of queue
        timeout - how long to wait before giving up, in units of unit
        unit - a TimeUnit determining how to interpret the timeout parameter
        Returns:
        the head element, or null if all sorted sets are empty
      • pollFirstAsync

        RFuture<V> pollFirstAsync​(long timeout,
                                  TimeUnit unit)
        Removes and returns the head element or null if this sorted set is empty.

        Requires Redis 5.0.0 and higher.

        Parameters:
        timeout - how long to wait before giving up, in units of unit
        unit - a TimeUnit determining how to interpret the timeout parameter
        Returns:
        the head element, or null if this sorted set is empty
      • takeFirstAsync

        RFuture<V> takeFirstAsync()
        Removes and returns the head element waiting if necessary for an element to become available.
        Returns:
        the head element
      • takeLastAsync

        RFuture<V> takeLastAsync()
        Removes and returns the tail element waiting if necessary for an element to become available.
        Returns:
        the tail element
      • pollLastAsync

        RFuture<V> pollLastAsync​(long timeout,
                                 TimeUnit unit)
        Removes and returns the tail element or null if this sorted set is empty.

        Requires Redis 5.0.0 and higher.

        Parameters:
        timeout - how long to wait before giving up, in units of unit
        unit - a TimeUnit determining how to interpret the timeout parameter
        Returns:
        the tail element or null if this sorted set is empty
      • pollFirstAsync

        RFuture<Collection<V>> pollFirstAsync​(int count)
        Removes and returns the head elements or null if this sorted set is empty.
        Parameters:
        count - - elements amount
        Returns:
        the head element, or null if this sorted set is empty
      • pollLastAsync

        RFuture<Collection<V>> pollLastAsync​(int count)
        Removes and returns the tail elements or null if this sorted set is empty.
        Parameters:
        count - - elements amount
        Returns:
        the tail element or null if this sorted set is empty
      • pollFirstAsync

        RFuture<V> pollFirstAsync()
        Removes and returns the head element or null if this sorted set is empty.
        Returns:
        the head element, or null if this sorted set is empty
      • pollLastAsync

        RFuture<V> pollLastAsync()
        Removes and returns the tail element or null if this sorted set is empty.
        Returns:
        the tail element or null if this sorted set is empty
      • firstAsync

        RFuture<V> firstAsync()
        Returns the head element or null if this sorted set is empty.
        Returns:
        the head element or null if this sorted set is empty
      • lastAsync

        RFuture<V> lastAsync()
        Returns the tail element or null if this sorted set is empty.
        Returns:
        the tail element or null if this sorted set is empty
      • firstScoreAsync

        RFuture<Double> firstScoreAsync()
        Returns score of the head element or returns null if this sorted set is empty.
        Returns:
        the tail element or null if this sorted set is empty
      • lastScoreAsync

        RFuture<Double> lastScoreAsync()
        Returns score of the tail element or returns null if this sorted set is empty.
        Returns:
        the tail element or null if this sorted set is empty
      • addAllAsync

        RFuture<Integer> addAllAsync​(Map<V,​Double> objects)
        Adds all elements contained in the specified map to this sorted set. Map contains of score mapped by object.
        Parameters:
        objects - - map of elements to add
        Returns:
        amount of added elements, not including already existing in this sorted set
      • removeRangeByScoreAsync

        RFuture<Integer> removeRangeByScoreAsync​(double startScore,
                                                 boolean startScoreInclusive,
                                                 double endScore,
                                                 boolean endScoreInclusive)
        Removes values by score range.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        Returns:
        number of elements removed
      • removeRangeByRankAsync

        RFuture<Integer> removeRangeByRankAsync​(int startIndex,
                                                int endIndex)
        Removes values by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.
        Parameters:
        startIndex - - start index
        endIndex - - end index
        Returns:
      • rankAsync

        RFuture<Integer> rankAsync​(V o)
        Returns rank of value, with the scores ordered from low to high.
        Parameters:
        o - - object
        Returns:
        rank or null if value does not exist
      • revRankAsync

        RFuture<Integer> revRankAsync​(V o)
        Returns rank of value, with the scores ordered from high to low.
        Parameters:
        o - - object
        Returns:
        rank or null if value does not exist
      • getScoreAsync

        RFuture<Double> getScoreAsync​(V o)
        Returns score of element or null if it doesn't exist.
        Parameters:
        o - - element
        Returns:
        score
      • addAsync

        RFuture<Boolean> addAsync​(double score,
                                  V object)
        Adds element to this set, overrides previous score if it has been already added.
        Parameters:
        score - - object score
        object - - object itself
        Returns:
        true if element has added and false if not.
      • addAndGetRankAsync

        RFuture<Integer> addAndGetRankAsync​(double score,
                                            V object)
        Adds element to this set, overrides previous score if it has been already added. Finally return the rank of the item
        Parameters:
        score - - object score
        object - - object itself
        Returns:
        rank
      • addAndGetRevRankAsync

        RFuture<Integer> addAndGetRevRankAsync​(double score,
                                               V object)
        Adds element to this set, overrides previous score if it has been already added. Finally return the reverse rank of the item
        Parameters:
        score - - object score
        object - - object itself
        Returns:
        reverse rank
      • tryAddAsync

        RFuture<Boolean> tryAddAsync​(double score,
                                     V object)
        Adds element to this set only if has not been added before.

        Requires Redis 3.0.2 and higher.

        Parameters:
        score - - object score
        object - - object itself
        Returns:
        true if element has added and false if not.
      • removeAsync

        RFuture<Boolean> removeAsync​(V o)
        Removes a single instance of the specified element from this sorted set, if it is present.
        Parameters:
        o - element to be removed from this sorted set, if present
        Returns:
        true if an element was removed as a result of this call
      • sizeAsync

        RFuture<Integer> sizeAsync()
        Returns size of this set.
        Returns:
        size
      • containsAsync

        RFuture<Boolean> containsAsync​(Object o)
        Returns true if this sorted set contains encoded state of the specified element.
        Parameters:
        o - element whose presence in this collection is to be tested
        Returns:
        true if this sorted set contains the specified element and false otherwise
      • containsAllAsync

        RFuture<Boolean> containsAllAsync​(Collection<?> c)
        Returns true if this sorted set contains all of the elements in encoded state in the specified collection.
        Parameters:
        c - collection to be checked for containment in this sorted set
        Returns:
        true if this sorted set contains all of the elements in the specified collection
      • removeAllAsync

        RFuture<Boolean> removeAllAsync​(Collection<?> c)
        Removes all of this sorted set's elements that are also contained in the specified collection.
        Parameters:
        c - sorted set containing elements to be removed from this collection
        Returns:
        true if this sorted set changed as a result of the call
      • retainAllAsync

        RFuture<Boolean> retainAllAsync​(Collection<?> c)
        Retains only the elements in this sorted set that are contained in the specified collection.
        Parameters:
        c - collection containing elements to be retained in this collection
        Returns:
        true if this sorted set changed as a result of the call
      • addScoreAsync

        RFuture<Double> addScoreAsync​(V element,
                                      Number value)
        Increases score of specified element by value.
        Parameters:
        element - - element whose score needs to be increased
        value - - value
        Returns:
        updated score of element
      • addScoreAndGetRevRankAsync

        RFuture<Integer> addScoreAndGetRevRankAsync​(V object,
                                                    Number value)
        Adds score to element and returns its reverse rank
        Parameters:
        object - - object itself
        value - - object score
        Returns:
        reverse rank
      • addScoreAndGetRankAsync

        RFuture<Integer> addScoreAndGetRankAsync​(V object,
                                                 Number value)
        Adds score to element and returns its rank
        Parameters:
        object - - object itself
        value - - object score
        Returns:
        rank
      • valueRangeAsync

        RFuture<Collection<V>> valueRangeAsync​(int startIndex,
                                               int endIndex)
        Returns values by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.
        Parameters:
        startIndex - - start index
        endIndex - - end index
        Returns:
        elements
      • valueRangeReversedAsync

        RFuture<Collection<V>> valueRangeReversedAsync​(int startIndex,
                                                       int endIndex)
        Returns values by rank range in reverse order. Indexes are zero based. -1 means the highest score, -2 means the second highest score.
        Parameters:
        startIndex - - start index
        endIndex - - end index
        Returns:
        elements
      • entryRangeAsync

        RFuture<Collection<ScoredEntry<V>>> entryRangeAsync​(int startIndex,
                                                            int endIndex)
        Returns entries (value and its score) by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.
        Parameters:
        startIndex - - start index
        endIndex - - end index
        Returns:
        entries
      • entryRangeReversedAsync

        RFuture<Collection<ScoredEntry<V>>> entryRangeReversedAsync​(int startIndex,
                                                                    int endIndex)
        Returns entries (value and its score) by rank range in reverse order. Indexes are zero based. -1 means the highest score, -2 means the second highest score.
        Parameters:
        startIndex - - start index
        endIndex - - end index
        Returns:
        entries
      • valueRangeAsync

        RFuture<Collection<V>> valueRangeAsync​(double startScore,
                                               boolean startScoreInclusive,
                                               double endScore,
                                               boolean endScoreInclusive)
        Returns all values between startScore and endScore.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        Returns:
        values
      • valueRangeReversedAsync

        RFuture<Collection<V>> valueRangeReversedAsync​(double startScore,
                                                       boolean startScoreInclusive,
                                                       double endScore,
                                                       boolean endScoreInclusive)
        Returns all values between startScore and endScore in reversed order.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        Returns:
        values
      • entryRangeAsync

        RFuture<Collection<ScoredEntry<V>>> entryRangeAsync​(double startScore,
                                                            boolean startScoreInclusive,
                                                            double endScore,
                                                            boolean endScoreInclusive)
        Returns all entries (value and its score) between startScore and endScore.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        Returns:
        entries
      • valueRangeAsync

        RFuture<Collection<V>> valueRangeAsync​(double startScore,
                                               boolean startScoreInclusive,
                                               double endScore,
                                               boolean endScoreInclusive,
                                               int offset,
                                               int count)
        Returns all values between startScore and endScore.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        offset - - offset of sorted data
        count - - amount of sorted data
        Returns:
        values
      • valueRangeReversedAsync

        RFuture<Collection<V>> valueRangeReversedAsync​(double startScore,
                                                       boolean startScoreInclusive,
                                                       double endScore,
                                                       boolean endScoreInclusive,
                                                       int offset,
                                                       int count)
        Returns all values between startScore and endScore in reversed order.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        offset - - offset of sorted data
        count - - amount of sorted data
        Returns:
        values
      • entryRangeAsync

        RFuture<Collection<ScoredEntry<V>>> entryRangeAsync​(double startScore,
                                                            boolean startScoreInclusive,
                                                            double endScore,
                                                            boolean endScoreInclusive,
                                                            int offset,
                                                            int count)
        Returns all entries (value and its score) between startScore and endScore.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        offset - - offset of sorted data
        count - - amount of sorted data
        Returns:
        entries
      • entryRangeReversedAsync

        RFuture<Collection<ScoredEntry<V>>> entryRangeReversedAsync​(double startScore,
                                                                    boolean startScoreInclusive,
                                                                    double endScore,
                                                                    boolean endScoreInclusive)
        Returns all entries (value and its score) between startScore and endScore in reversed order.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        Returns:
        entries
      • entryRangeReversedAsync

        RFuture<Collection<ScoredEntry<V>>> entryRangeReversedAsync​(double startScore,
                                                                    boolean startScoreInclusive,
                                                                    double endScore,
                                                                    boolean endScoreInclusive,
                                                                    int offset,
                                                                    int count)
        Returns all entries (value and its score) between startScore and endScore in reversed order.
        Parameters:
        startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        startScoreInclusive - - start score inclusive
        endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers
        endScoreInclusive - - end score inclusive
        offset - - offset of sorted data
        count - - amount of sorted data
        Returns:
        entries
      • countAsync

        RFuture<Integer> countAsync​(double startScore,
                                    boolean startScoreInclusive,
                                    double endScore,
                                    boolean endScoreInclusive)
        Returns the number of elements with a score between startScore and endScore.
        Parameters:
        startScore - - start score
        startScoreInclusive - - start score inclusive
        endScore - - end score
        endScoreInclusive - - end score inclusive
        Returns:
        count
      • readAllAsync

        RFuture<Collection<V>> readAllAsync()
        Read all values at once.
        Returns:
        values
      • intersectionAsync

        RFuture<Integer> intersectionAsync​(String... names)
        Intersect provided ScoredSortedSets and store result to current ScoredSortedSet
        Parameters:
        names - - names of ScoredSortedSet
        Returns:
        length of intersection
      • intersectionAsync

        RFuture<Integer> intersectionAsync​(RScoredSortedSet.Aggregate aggregate,
                                           String... names)
        Intersect provided ScoredSortedSets with defined aggregation method and store result to current ScoredSortedSet
        Parameters:
        aggregate - - score aggregation mode
        names - - names of ScoredSortedSet
        Returns:
        length of intersection
      • intersectionAsync

        RFuture<Integer> intersectionAsync​(Map<String,​Double> nameWithWeight)
        Intersect provided ScoredSortedSets mapped to weight multiplier and store result to current ScoredSortedSet
        Parameters:
        nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier
        Returns:
        length of intersection
      • intersectionAsync

        RFuture<Integer> intersectionAsync​(RScoredSortedSet.Aggregate aggregate,
                                           Map<String,​Double> nameWithWeight)
        Intersect provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and store result to current ScoredSortedSet
        Parameters:
        aggregate - - score aggregation mode
        nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier
        Returns:
        length of intersection
      • unionAsync

        RFuture<Integer> unionAsync​(String... names)
        Union provided ScoredSortedSets and store result to current ScoredSortedSet
        Parameters:
        names - - names of ScoredSortedSet
        Returns:
        length of union
      • unionAsync

        RFuture<Integer> unionAsync​(RScoredSortedSet.Aggregate aggregate,
                                    String... names)
        Union provided ScoredSortedSets with defined aggregation method and store result to current ScoredSortedSet
        Parameters:
        aggregate - - score aggregation mode
        names - - names of ScoredSortedSet
        Returns:
        length of union
      • unionAsync

        RFuture<Integer> unionAsync​(Map<String,​Double> nameWithWeight)
        Union provided ScoredSortedSets mapped to weight multiplier and store result to current ScoredSortedSet
        Parameters:
        nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier
        Returns:
        length of union
      • unionAsync

        RFuture<Integer> unionAsync​(RScoredSortedSet.Aggregate aggregate,
                                    Map<String,​Double> nameWithWeight)
        Union provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and store result to current ScoredSortedSet
        Parameters:
        aggregate - - score aggregation mode
        nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier
        Returns:
        length of union