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.
config filename
path pointing to the scredis config object
the constructed scredis.SubscriberClient
The path must include to the scredis object, e.g. x.y.scredis
Constructs a scredis.SubscriberClient instance from a config file.
Constructs a scredis.SubscriberClient instance from a config file.
config filename
the constructed scredis.SubscriberClient
The config file must contain the scredis object at its root. This constructor is equivalent to
new Client(configName, "scredis")
Constructs a scredis.SubscriberClient instance from a com.typesafe.Config
Constructs a scredis.SubscriberClient instance from a com.typesafe.Config
com.typesafe.Config
the constructed scredis.SubscriberClient
The config must contain the scredis object at its root. This constructor is equivalent to
new Client(config, "scredis")
Constructs a scredis.SubscriberClient instance from a scredis.RedisConfig
Constructs a scredis.SubscriberClient instance from a scredis.RedisConfig
the constructed scredis.SubscriberClient
server address
server port
optional server password
optional client name (available since 2.6.9)
connection timeout
optional batch receive timeout
max number of bytes to send as part of a batch
size hint of the tcp send buffer, in bytes
size hint of the tcp receive buffer, in bytes
path to listener dispatcher definition
path to io dispatcher definition
path to decoder dispatcher definition
Authenticates to the server.
Authenticates to the server.
the server password
1.0.0
if authentication failed
Use the empty string to re-authenticate with no password.
Waits for all the internal actors to be shutdown.
Waits for all the internal actors to be shutdown.
amount of time to wait
This method is usually called after issuing a QUIT command
Sets the current client name.
Sets the current client name. If the empty string is provided, the name will be unset.
name to associate the client to, if empty, unsets the client name
2.6.9
Listens for messages published to channels matching the given patterns.
Listens for messages published to channels matching the given patterns.
the patterns
partial function handling received messages
the total number of subscribed channels and patterns
2.0.0
Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional SUBSCRIBE, PSUBSCRIBE, UNSUBSCRIBE and PUNSUBSCRIBE commands.
Stops listening for messages published to channels matching the given patterns.
Stops listening for messages published to channels matching the given patterns.
the patterns, if empty, unsubscribe from all patterns
the total number of subscribed channels and patterns
2.0.0
When no patterns are specified, the client is unsubscribed from all the previously subscribed patterns. In this case, a message for every unsubscribed pattern will be sent to the client.
Unsubscribes from all subscribed channels/patterns and then closes the connection.
Listens for messages published to the given channels.
Listens for messages published to the given channels.
channel name(s) of channel(s) to listen to
partial function handling received messages
the total number of subscribed channels and patterns
2.0.0
Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional SUBSCRIBE, PSUBSCRIBE, UNSUBSCRIBE and PUNSUBSCRIBE commands.
Stops listening for messages published to the given channels.
Stops listening for messages published to the given channels.
the names of the channels, if empty, unsubscribe from all channels
the total number of subscribed channels and patterns
2.0.0
When no channels are specified, the client is unsubscribed from all the previously subscribed channels. In this case, a message for every unsubscribed channel will be sent to the client.
Defines a Pub/Sub Redis client capable of subscribing to channels/patterns.