trait PubSubCommands[F[_], S[_], K, V] extends PublishCommands[F, S, K, V] with SubscribeCommands[F, S, K, V]
- F
the effect type
- S
the stream type
- K
the channel key type
- V
the value type
- Source
- PubSubCommands.scala
- Alphabetic
- By Inheritance
- PubSubCommands
- SubscribeCommands
- PublishCommands
- PubSubStats
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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.
- Definition Classes
- SubscribeCommands
- See also
SubscribeCommands.subscribe for more information.
- 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.
- Definition Classes
- SubscribeCommands
- See also
SubscribeCommands.psubscribe for more information.
- abstract def numPat: F[Long]
- Definition Classes
- PubSubStats
- abstract def numSub: F[List[Subscription[K]]]
- Definition Classes
- PubSubStats
- abstract def psubscribe(channel: RedisPattern[K]): S[RedisPatternEvent[K, V]]
Subscribes to a pattern.
Subscribes to a pattern.
- Definition Classes
- SubscribeCommands
- Note
If you invoke
subscribemultiple 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 whenunsubscribeis invoked.
- abstract def pubSubChannels: F[List[RedisChannel[K]]]
- Definition Classes
- PubSubStats
- abstract def pubSubShardChannels: F[List[RedisChannel[K]]]
- Definition Classes
- PubSubStats
- abstract def pubSubSubscriptions(channels: List[RedisChannel[K]]): F[List[Subscription[K]]]
- Definition Classes
- PubSubStats
- abstract def pubSubSubscriptions(channel: RedisChannel[K]): F[Option[Subscription[K]]]
- Definition Classes
- PubSubStats
- abstract def publish(channel: RedisChannel[K], value: V): F[Long]
- returns
The number of clients that received the message.
- Definition Classes
- PublishCommands
- abstract def publish(channel: RedisChannel[K]): (S[V]) => S[Long]
- returns
The number of clients that received the message.
- Definition Classes
- PublishCommands
- abstract def punsubscribe(channel: RedisPattern[K]): F[Unit]
Terminates all streams that are subscribed to the pattern.
Terminates all streams that are subscribed to the pattern.
- Definition Classes
- SubscribeCommands
- abstract def shardNumSub(channels: List[RedisChannel[K]]): F[List[Subscription[K]]]
- Definition Classes
- PubSubStats
- abstract def subscribe(channel: RedisChannel[K]): S[V]
Subscribes to a channel.
Subscribes to a channel.
- Definition Classes
- SubscribeCommands
- Note
If you invoke
subscribemultiple 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 whenunsubscribeis invoked.
- abstract def unsubscribe(channel: RedisChannel[K]): F[Unit]
Terminates all streams that are subscribed to the channel.
Terminates all streams that are subscribed to the channel.
- Definition Classes
- SubscribeCommands
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toany2stringadd[PubSubCommands[F, S, K, V]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (PubSubCommands[F, S, K, V], B)
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toArrowAssoc[PubSubCommands[F, S, K, V]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def ensuring(cond: (PubSubCommands[F, S, K, V]) => Boolean, msg: => Any): PubSubCommands[F, S, K, V]
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toEnsuring[PubSubCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (PubSubCommands[F, S, K, V]) => Boolean): PubSubCommands[F, S, K, V]
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toEnsuring[PubSubCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): PubSubCommands[F, S, K, V]
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toEnsuring[PubSubCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): PubSubCommands[F, S, K, V]
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toEnsuring[PubSubCommands[F, S, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toStringFormat[PubSubCommands[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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (PubSubCommands[F, S, K, V], B)
- Implicit
- This member is added by an implicit conversion from PubSubCommands[F, S, K, V] toArrowAssoc[PubSubCommands[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.
This is the API documentation for the Redis4Cats library.