Packages

trait SubscribeCommands[F[_], S[_], K, V] extends AnyRef

F

the effect type

S

the stream type

K

the channel key type

V

the value type

Source
PubSubCommands.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
PubSubCommands
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscribeCommands
  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 internalChannelSubscriptions: F[Map[RedisChannel[K], Long]]

    Returns the channel subscriptions that the library keeps of.

    Returns the channel subscriptions that the library keeps of.

    returns

    how many streams are subscribed to each channel.

    See also

    SubscribeCommands.subscribe for more information.

  2. abstract def internalPatternSubscriptions: F[Map[RedisPattern[K], Long]]

    Returns the pattern subscriptions that the library keeps of.

    Returns the pattern subscriptions that the library keeps of.

    returns

    how many streams are subscribed to each pattern.

    See also

    SubscribeCommands.psubscribe for more information.

  3. abstract def psubscribe(channel: RedisPattern[K]): S[RedisPatternEvent[K, V]]

    Subscribes to a pattern.

    Subscribes to a pattern.

    Note

    If you invoke subscribe multiple times for the same pattern, we will not call 'SUBSCRIBE' in Redis multiple times but instead will return a stream that will use the existing subscription to that pattern. The underlying subscription is cleaned up when all the streams terminate or when unsubscribe is invoked.

  4. abstract def punsubscribe(channel: RedisPattern[K]): F[Unit]

    Terminates all streams that are subscribed to the pattern.

  5. abstract def subscribe(channel: RedisChannel[K]): S[V]

    Subscribes to a channel.

    Subscribes to a channel.

    Note

    If you invoke subscribe multiple times for the same channel, we will not call 'SUBSCRIBE' in Redis multiple times but instead will return a stream that will use the existing subscription to that channel. The underlying subscription is cleaned up when all the streams terminate or when unsubscribe is invoked.

  6. abstract def unsubscribe(channel: RedisChannel[K]): F[Unit]

    Terminates all streams that are subscribed to the channel.

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 SubscribeCommands[F, S, K, V] toany2stringadd[SubscribeCommands[F, S, K, V]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SubscribeCommands[F, S, K, V], B)
    Implicit
    This member is added by an implicit conversion from SubscribeCommands[F, S, K, V] toArrowAssoc[SubscribeCommands[F, S, 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: (SubscribeCommands[F, S, K, V]) => Boolean, msg: => Any): SubscribeCommands[F, S, K, V]
    Implicit
    This member is added by an implicit conversion from SubscribeCommands[F, S, K, V] toEnsuring[SubscribeCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (SubscribeCommands[F, S, K, V]) => Boolean): SubscribeCommands[F, S, K, V]
    Implicit
    This member is added by an implicit conversion from SubscribeCommands[F, S, K, V] toEnsuring[SubscribeCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): SubscribeCommands[F, S, K, V]
    Implicit
    This member is added by an implicit conversion from SubscribeCommands[F, S, K, V] toEnsuring[SubscribeCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): SubscribeCommands[F, S, K, V]
    Implicit
    This member is added by an implicit conversion from SubscribeCommands[F, S, K, V] toEnsuring[SubscribeCommands[F, S, 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 SubscribeCommands[F, S, K, V] toStringFormat[SubscribeCommands[F, S, 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): (SubscribeCommands[F, S, K, V], B)
    Implicit
    This member is added by an implicit conversion from SubscribeCommands[F, S, K, V] toArrowAssoc[SubscribeCommands[F, S, 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 fromSubscribeCommands[F, S, K, V] to any2stringadd[SubscribeCommands[F, S, K, V]]

Inherited by implicit conversion StringFormat fromSubscribeCommands[F, S, K, V] to StringFormat[SubscribeCommands[F, S, K, V]]

Inherited by implicit conversion Ensuring fromSubscribeCommands[F, S, K, V] to Ensuring[SubscribeCommands[F, S, K, V]]

Inherited by implicit conversion ArrowAssoc fromSubscribeCommands[F, S, K, V] to ArrowAssoc[SubscribeCommands[F, S, K, V]]

Ungrouped