SessionService(opts)

new SessionService(opts)
lib/common/service/sessionService.js, line 24

Session service maintains the internal session for each client connection. Session service is created by session component and is only available in frontend servers. You can access the service by `app.get('sessionService')` or `app.sessionService` in frontend servers.
Parameters:
Name Type Description
opts Object constructor parameters

Methods

bind()
lib/common/service/sessionService.js, line 58

Bind the session with a user id.

create(sid, frontendId, socket) → {Session}
lib/common/service/sessionService.js, line 45

Create and return internal session.
Parameters:
Name Type Description
sid Integer uniqe id for the internal session
frontendId String frontend server in which the internal session is created
socket Object the underlying socket would be held by the internal session
Returns:
Session

forEachBindedSession(cb)
lib/common/service/sessionService.js, line 394

Iterate all the binded session in the session service.
Parameters:
Name Type Description
cb function callback function to fetch session

forEachSession(cb)
lib/common/service/sessionService.js, line 382

Iterate all the session in the session service.
Parameters:
Name Type Description
cb function callback function to fetch session

get(id) → {Session}
lib/common/service/sessionService.js, line 164

Get session by id.
Parameters:
Name Type Description
id Number The session id
Returns:
Session

getByUid(uid) → {Array}
lib/common/service/sessionService.js, line 177

Get sessions by userId.
Parameters:
Name Type Description
uid Number User id associated with the session
Returns:
Array - list of session binded with the uid

getClientAddressBySessionId(sid) → {Object}
lib/common/service/sessionService.js, line 321

Get client remote address by session id.
Parameters:
Name Type Description
sid Number session id
Returns:
Object - remote address of client

getSessionsCount()
lib/common/service/sessionService.js, line 408

Get sessions' quantity in specified server.

import()
lib/common/service/sessionService.js, line 217

Import the key/value into session.

importAll()
lib/common/service/sessionService.js, line 233

Import new value for the existed session.

kick(uid, cb)
lib/common/service/sessionService.js, line 254

Kick all the session offline under the user id.
Parameters:
Name Type Description
uid Number user id asscociated with the session
cb function callback function

kickBySessionId(sid, cb)
lib/common/service/sessionService.js, line 292

Kick a user offline by session id.
Parameters:
Name Type Description
sid Number session id
cb function callback function

remove(sid)
lib/common/service/sessionService.js, line 189

Remove session by key.
Parameters:
Name Type Description
sid Number The session id

sendMessage(sid, msg)
lib/common/service/sessionService.js, line 340

Send message to the client by session id.
Parameters:
Name Type Description
sid String session id
msg Object message to send

sendMessageByUid(uid, msg)
lib/common/service/sessionService.js, line 360

Send message to the client by user id.
Parameters:
Name Type Description
uid String userId
msg Object message to send

unbind()
lib/common/service/sessionService.js, line 117

Unbind a session with the user id.