API Docs for: 0.8.0
Show:

MongoSessionStore Class

Defined in: include/session/storage/mongo_session_store.js:25
Module: Session

Session storage backed by MongoDB

Item Index

Methods

Properties

Methods

clear

(
  • sessionId
  • cb
)

Defined in include/session/storage/mongo_session_store.js:89

Deletes a session if it exists.

Parameters:

  • sessionId String
  • cb Function

    Callback of form cb(err, [int SESSIONS_CLEARED])

get

(
  • sessionId
  • cb
)

Defined in include/session/storage/mongo_session_store.js:54

Responsible for retrieving the session for persistent storage.

Parameters:

  • sessionId String

    The identifier of the session to retrieve.

  • cb Function

    Callback of form cb(err, [Object])

getHandler

(
  • cb
)
Function static

Defined in include/session/storage/mongo_session_store.js:151

Parameters:

  • cb Function

Returns:

Function:

getSessionQuery

(
  • sessionId
)
Object

Defined in include/session/storage/mongo_session_store.js:139

Constructs a query to find a session in Mongo

Parameters:

  • sessionId String

    The session identifier

Returns:

Object:

set

(
  • session
  • cb
)

Defined in include/session/storage/mongo_session_store.js:66

Responsible for persisting the session object between user requests

Parameters:

  • session !~YUIDOC_LINE~! uid: primitive!~YUIDOC_LINE~!

    The session object to store. The session object must contain the following in addition to other data:
  • cb Function

    Callback of form cb(err, 'OK')

shutdown

(
  • cb
)

Defined in include/session/storage/mongo_session_store.js:101

Responsable for shutting down the session store and any resources used for reaping expired sessions.

Parameters:

  • cb Function

start

()

Defined in include/session/storage/mongo_session_store.js:112

Responsable for ensuring that the mechanism that expires sessions becomes active.

Properties

INDEX_MOD_LOCK_KEY

String private static

Defined in include/session/storage/mongo_session_store.js:44

The cache lock key used when the index is needed to be modified

SESSION_COLLECTION_NAME

String private static

Defined in include/session/storage/mongo_session_store.js:34

The mongo collection that stores the sessions