Packages

class SessionStore extends AnyRef

A session store is used to store sessions for an Vert.x-Web web app

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

Instance Constructors

  1. new SessionStore(_asJava: AnyRef)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava: AnyRef
  6. def clear(resultHandler: Handler[AsyncResult[Unit]]): Unit

    Remove all sessions from the store.

    Remove all sessions from the store. * @param resultHandler will be called with a success or a failure

  7. def clearFuture(): Future[Unit]

    Like clear but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def close(): Unit

    Close the store

  10. def createSession(timeout: Long, length: Int): Session

    Create a new session.

    Create a new session. * @param timeout - the session timeout, in ms

    length

    - the required length for the session id

    returns

    the session

  11. def createSession(timeout: Long): Session

    Create a new session using the default min length.

    Create a new session using the default min length. * @param timeout - the session timeout, in ms

    returns

    the session

  12. def delete(id: String, resultHandler: Handler[AsyncResult[Unit]]): Unit

    Delete the session with the specified ID.

    Delete the session with the specified ID. * @param id the session id

    resultHandler

    will be called with a success or a failure

  13. def deleteFuture(id: String): Future[Unit]

    Like delete but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def get(cookieValue: String, resultHandler: Handler[AsyncResult[Option[Session]]]): Unit

    Get the session with the specified ID.

    Get the session with the specified ID. * @param cookieValue the unique ID of the session

    resultHandler

    will be called with a result holding the session, or a failure

  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getFuture(cookieValue: String): Future[Option[Session]]

    Like get but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def init(vertx: Vertx, options: JsonObject): SessionStore

    Initialize this store.

    Initialize this store. * @param vertx the vertx instance

    options

    optional Json with extra configuration options

    returns

    self

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def put(session: Session, resultHandler: Handler[AsyncResult[Unit]]): Unit

    Add a session with the specified ID.

    Add a session with the specified ID. * @param session the session

    resultHandler

    will be called with a success or a failure

  27. def putFuture(session: Session): Future[Unit]

    Like put but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  28. def retryTimeout(): Long

    The retry timeout value in milli seconds used by the session handler when it retrieves a value from the store.

    The retry timeout value in milli seconds used by the session handler when it retrieves a value from the store.

    A non positive value means there is no retry at all. * @return the timeout value, in ms

  29. def size(resultHandler: Handler[AsyncResult[Int]]): Unit

    Get the number of sessions in the store.

    Get the number of sessions in the store.

    Beware of the result which is just an estimate, in particular with distributed session stores. * @param resultHandler will be called with the number, or a failure

  30. def sizeFuture(): Future[Int]

    Like size but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped