trait PublishAndStatsCommands[F[_], K, V] extends Publish[F, K, V] with PubSubStats[F, K]
Combines publishing and pub/sub statistics commands.
Note: This trait does NOT include subscribe functionality. For full pub/sub with subscriptions, see the streams module's PubSubCommands.
- Source
- publish.scala
- Alphabetic
- By Inheritance
- PublishAndStatsCommands
- PubSubStats
- Publish
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def numPat: F[Long]
Returns the total number of pattern subscriptions across all clients.
Returns the total number of pattern subscriptions across all clients.
- returns
the number of active pattern subscriptions
- Definition Classes
- PubSubStats
- abstract def numSub(channels: NonEmptyList[RedisChannel[K]]): F[List[Subscription[K]]]
Returns the number of subscribers for the specified channels.
Returns the number of subscribers for the specified channels.
- channels
non-empty list of channels to query
- returns
list of subscriptions for the specified channels
- Definition Classes
- PubSubStats
- abstract def pubSubChannels: F[List[RedisChannel[K]]]
Lists all currently active channels.
- abstract def pubSubShardChannels: F[List[RedisChannel[K]]]
Lists all currently active shard channels.
Lists all currently active shard channels.
- returns
list of active shard channels
- Definition Classes
- PubSubStats
- abstract def pubSubSubscriptions(channels: List[RedisChannel[K]]): F[List[Subscription[K]]]
Returns the subscription information for the specified channels.
Returns the subscription information for the specified channels.
- channels
the channels to query
- returns
list of subscriptions for the specified channels
- Definition Classes
- PubSubStats
- abstract def pubSubSubscriptions(channel: RedisChannel[K]): F[Option[Subscription[K]]]
Returns the subscription information for a specific channel.
Returns the subscription information for a specific channel.
- channel
the channel to query
- returns
subscription information if the channel exists
- Definition Classes
- PubSubStats
- abstract def publish(channel: RedisChannel[K], message: V): F[Long]
Publishes a message to the given channel.
Publishes a message to the given channel.
- channel
the Redis channel to publish to
- message
the message value to publish
- returns
the number of clients that received the message
- Definition Classes
- Publish
- abstract def shardNumSub(channels: List[RedisChannel[K]]): F[List[Subscription[K]]]
Returns the number of subscribers for the specified shard channels.
Returns the number of subscribers for the specified shard channels.
- channels
the shard channels to query
- returns
list of subscriptions for the specified shard channels
- Definition Classes
- PubSubStats
- abstract def spublish(channel: RedisChannel[K], message: V): F[Long]
Publishes a message to the given shard channel.
Publishes a message to the given shard channel.
- channel
the Redis shard channel to publish to
- message
the message value to publish
- returns
the number of clients that received the message
- Definition Classes
- Publish
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 PublishAndStatsCommands[F, K, V] toany2stringadd[PublishAndStatsCommands[F, K, V]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (PublishAndStatsCommands[F, K, V], B)
- Implicit
- This member is added by an implicit conversion from PublishAndStatsCommands[F, K, V] toArrowAssoc[PublishAndStatsCommands[F, 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: (PublishAndStatsCommands[F, K, V]) => Boolean, msg: => Any): PublishAndStatsCommands[F, K, V]
- Implicit
- This member is added by an implicit conversion from PublishAndStatsCommands[F, K, V] toEnsuring[PublishAndStatsCommands[F, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (PublishAndStatsCommands[F, K, V]) => Boolean): PublishAndStatsCommands[F, K, V]
- Implicit
- This member is added by an implicit conversion from PublishAndStatsCommands[F, K, V] toEnsuring[PublishAndStatsCommands[F, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): PublishAndStatsCommands[F, K, V]
- Implicit
- This member is added by an implicit conversion from PublishAndStatsCommands[F, K, V] toEnsuring[PublishAndStatsCommands[F, K, V]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): PublishAndStatsCommands[F, K, V]
- Implicit
- This member is added by an implicit conversion from PublishAndStatsCommands[F, K, V] toEnsuring[PublishAndStatsCommands[F, 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 PublishAndStatsCommands[F, K, V] toStringFormat[PublishAndStatsCommands[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 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): (PublishAndStatsCommands[F, K, V], B)
- Implicit
- This member is added by an implicit conversion from PublishAndStatsCommands[F, K, V] toArrowAssoc[PublishAndStatsCommands[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.
This is the API documentation for the Redis4Cats library.