Trait

com.comcast.xfinity.sirius.api

RequestHandler

Related Doc: package api

Permalink

trait RequestHandler extends AnyRef

Interface for a Sirius wrapped data structure for applying operations to the in memory dataset. All interactions with this object should go through Sirius. Operations should be short and to the point and should at all costs not throw exceptions.

Access to this object is kept synchronized by Sirius.

Puts and Deletes to the same key should cancel each other out. Also successive puts should cancel each other out.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestHandler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def handleDelete(key: String): SiriusResult

    Permalink

    Handle a DELETE request

    Handle a DELETE request

    key

    unique identifier for the item to which the operation is being applied

    returns

    a SiriusResult wrapping the result of the operation. This should almost always be SiriusResult.none(). In the future the API may be modified to return void.

  2. abstract def handleGet(key: String): SiriusResult

    Permalink

    Handle a GET request

    Handle a GET request

    key

    String identifying the search query

    returns

    a SiriusResult wrapping the result of the query

  3. abstract def handlePut(key: String, body: Array[Byte]): SiriusResult

    Permalink

    Handle a PUT request

    Handle a PUT request

    key

    unique identifier for the item to which the operation is being applied

    body

    data passed in along with this request used for modifying the state at key

    returns

    a SiriusResult wrapping the result of the operation. This should almost always be SiriusResult.none(). In the future the API may be modified to return void.

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped