Class

curiodb

Command

Related Doc: package curiodb

Permalink

case class Command(input: Seq[Any] = Seq(), client: Option[ActorRef] = None, db: String = "0", clientId: String = "", id: String = ..., createdInTransaction: Boolean = false) extends Product with Serializable

Main payload for a command - stores its name, key, and args, and contains utility methods for looking up attributes configured via commands.conf.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Command
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Command(input: Seq[Any] = Seq(), client: Option[ActorRef] = None, db: String = "0", clientId: String = "", id: String = ..., createdInTransaction: Boolean = false)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val args: Seq[String]

    Permalink

    Command's arguments, namely all input after the command's name, and its key when it's a real key for a Node (defined by the "keyed" attribute).

  5. lazy val argsInRange: Boolean

    Permalink

    Validates that the arguments are in range for the command.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def attribute(attributeName: String): String

    Permalink

    Attribute lookup used in all the methods below.

  8. lazy val broadcast: Boolean

    Permalink

    When the command is routed (via CommandProcessing.route) it should be broadcast to all KeyNode actors.

  9. val client: Option[ActorRef]

    Permalink
  10. val clientId: String

    Permalink
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val createdInTransaction: Boolean

    Permalink
  13. val db: String

    Permalink
  14. lazy val default: Any

    Permalink

    Returns the default value the command should respond with when its key doesn't exist.

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. val id: String

    Permalink
  19. def indexOf(arg: String): Int

    Permalink

    Checks the position of an uppercase arg, since many commands use keywords within arguments, like the SORT command and many of the sorted set commands.

  20. val input: Seq[Any]

    Permalink
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. val key: String

    Permalink

    Command's key.

    Command's key. This is always considered to be the second item in the input, even though it might not strictly be the key of a Node, such as script sha values, and pubsub channels. Treating these as keys allows a consistent approach for hashing, as required by KeyNode routing.

  23. lazy val keyed: Boolean

    Permalink

    Does the command operate on a single key, provided by the next arg after its name.

    Does the command operate on a single key, provided by the next arg after its name. The default is true since most commands are modelled this way.

  24. lazy val keys: Seq[String]

    Permalink

    Returns all arguments in a command that represent keys.

  25. lazy val kind: String

    Permalink

    The type of node the command is for, eg string, list, hash, etc.

  26. val name: String

    Permalink

    Command's name.

    Command's name. The default state of a command on a Node when it starts is an empty Command that contains no input. In that case, we just set name to an empty string, which only requires checking on attribute lookup.

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. lazy val overwrites: Boolean

    Permalink

    Is the command able to overwrite an existing Node entirely, which specifically refers to deleting it if it's of a different type.

  31. lazy val streaming: Boolean

    Permalink

    The command puts the ClientNode into streaming mode where timeouts aren't used, specifically PubSub subscription.

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    Command → AnyRef → Any
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. lazy val writes: Boolean

    Permalink

    Does the command write to a Node actor's value.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped