redis

Type Members

1. trait BroadcastGather extends AnyRef

   

2. case class BulkReply(data: ByteString) extends Reply with Product with Serializable

   

3. case class Command(command: String, args: Seq[ByteString]) extends Product with Serializable

   

   The Command class allows us to do basic parsing and building with minimal overhead

4. trait CommandHasher[T] extends AnyRef

   

5. class DelScatterGather[T] extends ScatterGather[T]

   

6. case class ErrorReply(message: String) extends MessageReply with Product with Serializable

   

7. case class IntegerReply(value: Long) extends Reply with Product with Serializable

   

8. case class MBulkReply(replies: Seq[Reply]) extends Reply with Product with Serializable

   

9. class MGetScatterGather[T] extends ScatterGather[T]

   

10. class MSetScatterGather[T] extends ScatterGather[T]

    

11. sealed abstract class MessageReply extends Reply

    

12. trait Redis extends Protocol

    

13. trait RedisClient[M[_]] extends LiftedClient[Redis, M]

    

    This trait houses the Redis API.

    This trait houses the Redis API. It contains implementations for most(not all) commands. In particular, this trait makes a best attempt at providing all implementations for: - Key commands - String commands - Hash commands - List commands - Set commands - Zset commands

    Commands not implemented yet are

    • scan commands
    • 'admin' commands, ie commands which aren't directly related to a data type.

    Just because these commands are not implemented, doesn't mean they cannot be used. The implementors of this trait provide a generic 'execute' command, which allows for the execution of arbitrary colossus.protocols.redis.Commandobjects. The calling code is responsible for handling the raw colossus.protocols.redis.Reply.

    In some cases if a command can return an optional response(ie: a bulk reply or nil reply, like 'get'), 2 variants are provided. One which will return the data directly, and fail if its not there, and another which returns an Option. This is done to provide the user with some flexibility in how they query data. The point being, if you want to query and fail on non existence, you don't have to deal w/ an intermediate Option.

    No camelcase? Yea..camelcasing redis commands looked and felt weird. MGet? mGet? mget? mSetNx? msetNX? etc. So, since all redis commands are uppercased(at least in the docs), I went with all lower case for the API. I just wanted something consistent looking. The only camelcasing is for the functions which return options ie: getOption.

    This trait tries its best to be redis version agonstic. It doesn't know anything about the version of redis you are communicating with, so, for example, if an 'hstrlen' command is issued to a redis server that's < 3.2, you will get an Exception.

    Some commands(mainly zset commands) have additional arguments which alter its behavior. Instead of trying to capture all the argument combinations the function provides a varargs ByteString so that the user can provide whatever trailing flags or options they want. Each command which has this behavior is noted in its docs.

14. class RedisClientCodec extends ClientCodec[Command, Reply]

    

15. case class RedisException(message: String) extends Exception with Product with Serializable

    

16. class RedisServerCodec extends ServerCodec[Command, Reply]

    

17. sealed trait Reply extends AnyRef

    

18. trait ScatterGather[T] extends AnyRef

    

19. case class StatusReply(message: String) extends MessageReply with Product with Serializable

    

20. case class UnexpectedRedisReplyException(message: String) extends Exception with Product with Serializable