# Class: ClusteredSessionStore

## vertx-web-js/clustered_session_store~ ClusteredSessionStore

#### new ClusteredSessionStore()

A session store which stores sessions in a distributed map so they are available across the cluster.

Source:
  - vertx-web-js/clustered_session_store.js, line 32

### Methods

#### clear(resultHandler)

Remove all sessions from the store

##### Parameters:

Name | Type | Description
--- | --- | ---
`resultHandler` | function | will be called with a result true/false, or a failure

Source:
  - vertx-web-js/clustered_session_store.js, line 137

#### close()

Close the store

Source:
  - vertx-web-js/clustered_session_store.js, line 175

#### createSession(timeout, length) → {Session}

Create a new session

##### Parameters:

Name | Type | Description
--- | --- | ---
`timeout` | number | the session timeout, in ms
`length` | number | the required length for the session id

Source:
  - vertx-web-js/clustered_session_store.js, line 62

##### Returns:

the session

Type
  Session

#### delete(id, resultHandler)

Delete the session with the specified ID

##### Parameters:

Name | Type | Description
--- | --- | ---
`id` | string | the unique ID of the session
`resultHandler` | function | will be called with a result true/false, or a failure

Source:
  - vertx-web-js/clustered_session_store.js, line 98

#### get(id, resultHandler)

Get the session with the specified ID

##### Parameters:

Name | Type | Description
--- | --- | ---
`id` | string | the unique ID of the session
`resultHandler` | function | will be called with a result holding the session, or a failure

Source:
  - vertx-web-js/clustered_session_store.js, line 78

#### put(session, resultHandler)

Add a session with the specified ID

##### Parameters:

Name | Type | Description
--- | --- | ---
`session` | Session | the session
`resultHandler` | function | will be called with a result true/false, or a failure

Source:
  - vertx-web-js/clustered_session_store.js, line 118

#### retryTimeout() → {number}

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.

Source:
  - vertx-web-js/clustered_session_store.js, line 47

##### Returns:

the timeout value, in ms

Type
  number

#### size(resultHandler)

Get the number of sessions in the store

##### Parameters:

Name | Type | Description
--- | --- | ---
`resultHandler` | function | will be called with the number, or a failure

Source:
  - vertx-web-js/clustered_session_store.js, line 156