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

Initializer
SessionStore(SessionStore unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
clearshared default void clear(Anything(Throwable?) resultHandler)

Remove all sessions from the store

Parameters:
  • resultHandler

    will be called with a success or a failure

closeshared default void close()

Close the store

createSessionshared default Session createSession(Integer timeout)

Create a new session using the default min length.

Parameters:
  • timeout
    • the session timeout, in ms
createSessionshared default Session createSession(Integer timeout, Integer length)

Create a new session

Parameters:
  • timeout
    • the session timeout, in ms
  • length
    • the required length for the session id
deleteshared default void delete(String id, Anything(Throwable?) resultHandler)

Delete the session with the specified ID

Parameters:
  • id

    the unique ID of the session

  • resultHandler

    will be called with a success or a failure

getshared default void get(String id, Anything(Throwable|Session?) resultHandler)

Get the session with the specified ID

Parameters:
  • id

    the unique ID of the session

  • resultHandler

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

putshared default void put(Session session, Anything(Throwable?) resultHandler)

Add a session with the specified ID

Parameters:
  • session

    the session

  • resultHandler

    will be called with a success or a failure

retryTimeoutshared default Integer retryTimeout()

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.

sizeshared default void size(Anything(Throwable|Integer) resultHandler)

Get the number of sessions in the store

Parameters:
  • resultHandler

    will be called with the number, or a failure

Inherited Methods
Methods inherited from: Object
equals