Package: io.vertx.groovy.ext.web.sstore

## [Groovy] Class SessionStore

- io.vertx.groovy.ext.web.sstore.SessionStore

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

- - ### Constructor Summary

    Constructors
    Constructor and description
    `SessionStore (Object delegate)`

  - ### Methods Summary

    Methods
    Type | Name and description
    --- | ---
    `void` | `clear(Handler<AsyncResult<Boolean>> resultHandler)` Remove all sessions from the store
    `void` | `close()` Close the store
    `Session` | `createSession(long timeout)` Create a new session
    `void` | `delete(String id, Handler<AsyncResult<Boolean>> resultHandler)` Delete the session with the specified ID
    `void` | `get(String id, Handler<AsyncResult<Session>> resultHandler)` Get the session with the specified ID
    `Object` | `getDelegate()`
    `void` | `put(Session session, Handler<AsyncResult<Boolean>> resultHandler)` Add a session with the specified ID
    `void` | `size(Handler<AsyncResult<Integer>> resultHandler)` Get the number of sessions in the store

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Constructor Detail

    - #### SessionStore(Object delegate)

  - ### Method Detail

    - #### void clear(Handler<AsyncResult<Boolean>> resultHandler)

      Remove all sessions from the store

      Parameters:
        `resultHandler` - will be called with a result true/false, or a failure

    - #### void close()

      Close the store

    - #### Session createSession(long timeout)

      Create a new session

      Returns:
        the session
      Parameters:
        `timeout` - - the session timeout, in ms

    - #### void delete(String id, Handler<AsyncResult<Boolean>> resultHandler)

      Delete the session with the specified ID

      Parameters:
        `id` - the unique ID of the session
        `resultHandler` - will be called with a result true/false, or a failure

    - #### void get(String id, Handler<AsyncResult<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

    - #### Object getDelegate()

    - #### void put(Session session, Handler<AsyncResult<Boolean>> resultHandler)

      Add a session with the specified ID

      Parameters:
        `session` - the session
        `resultHandler` - will be called with a result true/false, or a failure

    - #### void size(Handler<AsyncResult<Integer>> resultHandler)

      Get the number of sessions in the store

      Parameters:
        `resultHandler` - will be called with the number, or a failure