object SubscriberClient

The companion object provides additional friendly constructors.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscriberClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(configName: String, path: String, subscription: Subscription)(implicit system: ActorSystem): SubscriberClient

    Constructs a scredis.SubscriberClient instance from a config file and using the provided path.

    Constructs a scredis.SubscriberClient instance from a config file and using the provided path.

    configName

    config filename

    path

    path pointing to the scredis config object

    returns

    the constructed scredis.SubscriberClient

    Note

    The path must include to the scredis object, e.g. x.y.scredis

  5. def apply(configName: String, subscription: Subscription)(implicit system: ActorSystem): SubscriberClient

    Constructs a scredis.SubscriberClient instance from a config file.

    Constructs a scredis.SubscriberClient instance from a config file.

    configName

    config filename

    returns

    the constructed scredis.SubscriberClient

    Note

    The config file must contain the scredis object at its root. This constructor is equivalent to

    Client(configName, "scredis")
  6. def apply(config: Config, subscription: Subscription)(implicit system: ActorSystem): SubscriberClient

    Constructs a scredis.SubscriberClient instance from a com.typesafe.Config

    Constructs a scredis.SubscriberClient instance from a com.typesafe.Config

    config

    com.typesafe.Config

    returns

    the constructed scredis.SubscriberClient

    Note

    The config must contain the scredis object at its root. This constructor is equivalent to

    Client(config, "scredis")
  7. def apply(config: RedisConfig, subscription: Subscription)(implicit system: ActorSystem): SubscriberClient

    Constructs a scredis.SubscriberClient instance from a scredis.RedisConfig

    Constructs a scredis.SubscriberClient instance from a scredis.RedisConfig

    config

    scredis.RedisConfig

    subscription

    function handling events related to subscriptions

    returns

    the constructed scredis.SubscriberClient

  8. def apply(subscription: Subscription = RedisConfigDefaults.LoggingSubscription, host: String = RedisConfigDefaults.Redis.Host, port: Int = RedisConfigDefaults.Redis.Port, passwordOpt: Option[String] = RedisConfigDefaults.Redis.PasswordOpt, nameOpt: Option[String] = RedisConfigDefaults.Redis.NameOpt, connectTimeout: FiniteDuration = RedisConfigDefaults.IO.ConnectTimeout, receiveTimeoutOpt: Option[FiniteDuration] = RedisConfigDefaults.IO.ReceiveTimeoutOpt, maxWriteBatchSize: Int = RedisConfigDefaults.IO.MaxWriteBatchSize, tcpSendBufferSizeHint: Int = RedisConfigDefaults.IO.TCPSendBufferSizeHint, tcpReceiveBufferSizeHint: Int = RedisConfigDefaults.IO.TCPReceiveBufferSizeHint, akkaListenerDispatcherPath: String = RedisConfigDefaults.IO.Akka.ListenerDispatcherPath, akkaIODispatcherPath: String = RedisConfigDefaults.IO.Akka.IODispatcherPath, akkaDecoderDispatcherPath: String = RedisConfigDefaults.IO.Akka.DecoderDispatcherPath)(implicit system: ActorSystem): SubscriberClient

    Creates a scredis.SubscriberClient

    subscription

    function handling events related to subscriptions

    host

    server address

    port

    server port

    passwordOpt

    optional server password

    nameOpt

    optional client name (available since 2.6.9)

    connectTimeout

    connection timeout

    receiveTimeoutOpt

    optional batch receive timeout

    maxWriteBatchSize

    max number of bytes to send as part of a batch

    tcpSendBufferSizeHint

    size hint of the tcp send buffer, in bytes

    tcpReceiveBufferSizeHint

    size hint of the tcp receive buffer, in bytes

    akkaListenerDispatcherPath

    path to listener dispatcher definition

    akkaIODispatcherPath

    path to io dispatcher definition

    akkaDecoderDispatcherPath

    path to decoder dispatcher definition

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @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
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped