BackendSessionService()

new BackendSessionService()
lib/common/service/backendSessionService.js, line 24

Service that maintains backend sessions and the communication with frontend servers. BackendSessionService would be created in each server process and maintains backend sessions for current process and communicates with the relative frontend servers. BackendSessionService instance could be accessed by `app.get('backendSessionService')` or app.backendSessionService.

Methods

bind(frontendId, sid, uid, cb)
lib/common/service/backendSessionService.js, line 130

Bind the session with the specified user id. It would finally invoke the the sessionService.bind in the cooperating frontend server.
Parameters:
Name Type Description
frontendId String cooperating frontend server id
sid Number session id
uid String user id
cb function callback function

get(frontendId, sid, cb)
lib/common/service/backendSessionService.js, line 46

Get backend session by frontend server id and session id.
Parameters:
Name Type Description
frontendId String frontend server id that session attached
sid String session id
cb function callback function. args: cb(err, BackendSession)

getByUid(frontendId, uid, cb)
lib/common/service/backendSessionService.js, line 64

Get backend sessions by frontend server id and user id.
Parameters:
Name Type Description
frontendId String frontend server id that session attached
uid String user id binded with the session
cb function callback function. args: cb(err, BackendSessions)

kickBySid(frontendId, sid, cb)
lib/common/service/backendSessionService.js, line 82

Kick a session by session id.
Parameters:
Name Type Description
frontendId String cooperating frontend server id
sid Number session id
cb function callback function

kickByUid(frontendId, uid, reason, cb)
lib/common/service/backendSessionService.js, line 105

Kick sessions by user id.
Parameters:
Name Type Description
frontendId String cooperating frontend server id
uid Number | String user id
reason String kick reason
cb function callback function

push(frontendId, sid, key, value, cb)
lib/common/service/backendSessionService.js, line 170

Push the specified customized change to the frontend internal session.
Parameters:
Name Type Description
frontendId String cooperating frontend server id
sid Number session id
key String key in session that should be push
value Object value in session, primitive js object
cb function callback function

pushAll(frontendId, sid, settings, cb)
lib/common/service/backendSessionService.js, line 189

Push all the customized changes to the frontend internal session.
Parameters:
Name Type Description
frontendId String cooperating frontend server id
sid Number session id
settings Object key/values in session that should be push
cb function callback function

unbind(frontendId, sid, uid, cb)
lib/common/service/backendSessionService.js, line 150

Unbind the session with the specified user id. It would finally invoke the the sessionService.unbind in the cooperating frontend server.
Parameters:
Name Type Description
frontendId String cooperating frontend server id
sid Number session id
uid String user id
cb function callback function