Packages

class LocalSessionStore extends SessionStore

A session store which is only available on a single node.

Can be used when sticky sessions are being used.

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

Instance Constructors

  1. new LocalSessionStore(_asJava: AnyRef)

Value Members

  1. def asJava: AnyRef
    Definition Classes
    SessionStore
  2. 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

    Definition Classes
    SessionStore
  3. def clearFuture(): Future[Unit]

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

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

    Definition Classes
    SessionStore
  4. def close(): Unit

    Close the store

    Close the store

    Definition Classes
    SessionStore
  5. 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

    Definition Classes
    SessionStore
  6. 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

    Definition Classes
    SessionStore
  7. 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

    Definition Classes
    SessionStore
  8. def deleteFuture(id: String): Future[Unit]

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

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

    Definition Classes
    SessionStore
  9. 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

    Definition Classes
    SessionStore
  10. def getFuture(cookieValue: String): Future[Option[Session]]

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

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

    Definition Classes
    SessionStore
  11. 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

    Definition Classes
    SessionStore
  12. 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

    Definition Classes
    SessionStore
  13. def putFuture(session: Session): Future[Unit]

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

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

    Definition Classes
    SessionStore
  14. 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

    Definition Classes
    SessionStore
  15. 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

    Definition Classes
    SessionStore
  16. def sizeFuture(): Future[Int]

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

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

    Definition Classes
    SessionStore