class SessionStore extends AnyRef
A session store is used to store sessions for an Vert.x-Web web app
- Alphabetic
- By Inheritance
- SessionStore
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new SessionStore(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: AnyRef
-
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
-
def
clearFuture(): Future[Unit]
Like clear but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
close(): Unit
Close the store
-
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
-
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
-
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
-
def
deleteFuture(id: String): Future[Unit]
Like delete but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getFuture(cookieValue: String): Future[Option[Session]]
Like get but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
def
putFuture(session: Session): Future[Unit]
Like put but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
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
-
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
-
def
sizeFuture(): Future[Int]
Like size but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )