t

dev.profunktor.redis4cats.algebra

StreamConsumerGroups

trait StreamConsumerGroups[F[_], K, V] extends AnyRef

Consumer-group commands for Redis Streams (the XGROUP/XREADGROUP/XACK/XCLAIM/XPENDING family).

For reading new (never-delivered) messages with xReadGroup, use XReadOffsets.custom(">", key).

Source
streams.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
RedisCommands, StreamCommands
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamConsumerGroups
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def xAck(key: K, group: K, ids: String*): F[Long]
  2. abstract def xAutoClaim(key: K, args: XAutoClaimArgs[K]): F[XAutoClaimResult[K, V]]
  3. abstract def xClaim(key: K, consumer: StreamConsumer[K], args: XClaimArgs, ids: String*): F[List[StreamMessage[K, V]]]
  4. abstract def xGroupCreate(key: K, group: K, offset: String = "$", args: XGroupCreateArgs = XGroupCreateArgs()): F[Unit]
  5. abstract def xGroupCreateConsumer(key: K, consumer: StreamConsumer[K]): F[Boolean]
  6. abstract def xGroupDelConsumer(key: K, consumer: StreamConsumer[K]): F[Long]
  7. abstract def xGroupDestroy(key: K, group: K): F[Boolean]
  8. abstract def xGroupSetId(key: K, group: K, offset: String): F[Unit]
  9. abstract def xPending(key: K, consumer: StreamConsumer[K], start: XRangePoint, end: XRangePoint, count: Long): F[List[XPendingMessage]]
  10. abstract def xPending(key: K, group: K, start: XRangePoint, end: XRangePoint, count: Long): F[List[XPendingMessage]]
  11. abstract def xPending(key: K, group: K): F[XPendingSummary]
  12. abstract def xReadGroup(consumer: StreamConsumer[K], streams: Set[XReadOffsets[K]], args: XReadGroupArgs = XReadGroupArgs()): F[List[StreamMessage[K, V]]]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toany2stringadd[StreamConsumerGroups[F, K, V]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (StreamConsumerGroups[F, K, V], B)
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toArrowAssoc[StreamConsumerGroups[F, K, V]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def ensuring(cond: (StreamConsumerGroups[F, K, V]) => Boolean, msg: => Any): StreamConsumerGroups[F, K, V]
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toEnsuring[StreamConsumerGroups[F, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (StreamConsumerGroups[F, K, V]) => Boolean): StreamConsumerGroups[F, K, V]
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toEnsuring[StreamConsumerGroups[F, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): StreamConsumerGroups[F, K, V]
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toEnsuring[StreamConsumerGroups[F, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): StreamConsumerGroups[F, K, V]
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toEnsuring[StreamConsumerGroups[F, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toStringFormat[StreamConsumerGroups[F, K, V]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (StreamConsumerGroups[F, K, V], B)
    Implicit
    This member is added by an implicit conversion from StreamConsumerGroups[F, K, V] toArrowAssoc[StreamConsumerGroups[F, K, V]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromStreamConsumerGroups[F, K, V] to any2stringadd[StreamConsumerGroups[F, K, V]]

Inherited by implicit conversion StringFormat fromStreamConsumerGroups[F, K, V] to StringFormat[StreamConsumerGroups[F, K, V]]

Inherited by implicit conversion Ensuring fromStreamConsumerGroups[F, K, V] to Ensuring[StreamConsumerGroups[F, K, V]]

Inherited by implicit conversion ArrowAssoc fromStreamConsumerGroups[F, K, V] to ArrowAssoc[StreamConsumerGroups[F, K, V]]

Ungrouped