API Docs for: 0.8.0
Show:

SessionHandler Class

Defined in: include/session/session.js:31
Module: Session

Responsible for managing user sessions

Item Index

Methods

Properties

Methods

close

(
  • session
  • cb
)

Defined in include/session/session.js:137

Closes the session and persists it when no other requests are currently accessing the session.

Parameters:

  • session Object
  • cb Function

create

(
  • request
)
Object

Defined in include/session/session.js:181

Creates the shell of a session object

Parameters:

  • request Object

Returns:

Object:

Session

end

(
  • session
  • cb
)

Defined in include/session/session.js:169

Sets the session in a state that it should be terminated after the last request has completed.

Parameters:

  • session Object
  • cb Function

getClientId

(
  • request
)
String static

Defined in include/session/session.js:212

Generates a unique client ID based on the user agent and the remote address.

Parameters:

  • request Object

Returns:

String:

Unique Id

getSessionCookie

(
  • session
)
Object static

Defined in include/session/session.js:289

Parameters:

  • session Object

Returns:

Object:

getSessionIdFromCookie

(
  • request
)
String static

Defined in include/session/session.js:266

Extracts the session id from the returned cookie

Parameters:

  • request Object

    The object that describes the incoming user request

Returns:

String:

Session Id if available NULL if it cannot be found

getSessionStore

() Function static

Defined in include/session/session.js:225

Loads a session store prototype based on the system configuration

Returns:

Function:

getSessionStore

() SessionStore static

Defined in include/session/session.js:255

Retrieves an instance of the SessionStore specified in the sytem configuration

Returns:

SessionStore:

open

(
  • request
  • cb
)

Defined in include/session/session.js:108

Retrieves a session for the current request. When the session ID is available the existing session is retrieved otherwise a new session is created.

Parameters:

  • request Object

    The request descriptor

  • cb Function

    The callback(ERROR, SESSION_OBJ)

shutdown

(
  • cb
)

Defined in include/session/session.js:202

Shuts down the sesison handler and the associated session store

Parameters:

  • cb Function

start

(
  • cb
)

Defined in include/session/session.js:99

Parameters:

  • cb Function

Properties

HANDLER_PATH

String static

Defined in include/session/session.js:45

HANDLER_SUFFIX

String static

Defined in include/session/session.js:54

SID_KEY

String static

Defined in include/session/session.js:63

TIMEOUT_KEY

String static

Defined in include/session/session.js:72