Class SessionComponent

Session component. Manage sessions.

param: current application context
param: attach parameters

Hierarchy

SessionService
- SessionComponent

Implements

IComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SessionComponent(app: Application, opts?: SessionServiceOptions): SessionComponent

Overrides SessionService.constructor
- Defined in components/session.ts:14
Parameters
- app: Application
- Optional opts: SessionServiceOptions
Returns SessionComponent

Properties

abind

abind: function = utils.promisify(this.bind)

Type declaration

- (sid: SID, uid: UID): Promise<void>
- Parameters
  - sid: SID
  - uid: UID
  Returns Promise<void>

aimport

aimport: function = utils.promisify(this.import)

Type declaration

- (sid: SID, key: string, value: any): Promise<void>
- Parameters
  - sid: SID
  - key: string
  - value: any
  Returns Promise<void>

aimportAll

aimportAll: function = utils.promisify(this.importAll)

Type declaration

- (sid: SID, settings: any): Promise<void>
- Parameters
  - sid: SID
  - settings: any
  Returns Promise<void>

akick

akick: function = utils.promisify(this.kick)

Type declaration

- (uid: UID, reason?: string): Promise<void>
- Parameters
  - uid: UID
  - Optional reason: string
  Returns Promise<void>

akickBySessionId

akickBySessionId: function = utils.promisify(this.kickBySessionId)

Type declaration

- (sid: SID, reason?: string): Promise<void>
- Parameters
  - sid: SID
  - Optional reason: string
  Returns Promise<void>

app

app: Application

aunbind

aunbind: function = utils.promisify(this.unbind)

Type declaration

- (sid: SID, uid: UID): Promise<void>
- Parameters
  - sid: SID
  - uid: UID
  Returns Promise<void>

name

name: string = "__session__"

sessions

sessions: object

Type declaration

[sid: number]: Session

singleSession

singleSession: Session

uidMap

uidMap: object

Type declaration

[uid: string]: Session[]

Methods

bind

bind(sid: SID, uid: UID, cb: function): void

Inherited from SessionService.bind
- Defined in common/service/sessionService.ts:68
Bind the session with a user id.

memberof

SessionService

api

private

Parameters
- sid: SID
- uid: UID
- cb: function
  - - (err: Error | null, result?: void): void
    - Parameters
      - err: Error | null
      - Optional result: void
      Returns void
Returns void

create

create(sid: SID, frontendId: FRONTENDID, socket: ISocket): Session

Inherited from SessionService.create
- Defined in common/service/sessionService.ts:54
Create and return internal session.

memberof

SessionService

api

private

Parameters
- sid: SID
  
  uniqe id for the internal session
- frontendId: FRONTENDID
  
  frontend server in which the internal session is created
- socket: ISocket
  
  the underlying socket would be held by the internal session
Returns Session

forEachBindedSession

forEachBindedSession(cb: function): void

Inherited from SessionService.forEachBindedSession
- Defined in common/service/sessionService.ts:461
Iterate all the binded session in the session service.

api

private

Parameters
- cb: function
  
  callback function to fetch session
  - - (session: Session): void
    - Parameters
      - session: Session
      Returns void
Returns void

forEachSession

forEachSession(cb: function): void

Inherited from SessionService.forEachSession
- Defined in common/service/sessionService.ts:447
Iterate all the session in the session service.

api

private

Parameters
- cb: function
  
  callback function to fetch session
  - - (session: Session): void
    - Parameters
      - session: Session
      Returns void
Returns void

get

get(sid: SID): Session

Inherited from SessionService.get
- Defined in common/service/sessionService.ts:196
Get session by id.

memberof

SessionService

api

private

Parameters
- sid: SID
Returns Session

getByUid

getByUid(uid: UID): Session[]

Inherited from SessionService.getByUid
- Defined in common/service/sessionService.ts:210
Get sessions by userId.

memberof

SessionService

api

private

Parameters
- uid: UID
  
  User id associated with the session
Returns Session[]

list of session binded with the uid

getClientAddressBySessionId

getClientAddressBySessionId(sid: SID): any

Inherited from SessionService.getClientAddressBySessionId
- Defined in common/service/sessionService.ts:380
Get client remote address by session id.

memberof

SessionService

Parameters
- sid: SID
  
  session id
Returns any

remote address of client

getSessionsCount

getSessionsCount(): number

Inherited from SessionService.getSessionsCount
- Defined in common/service/sessionService.ts:478
Get sessions' quantity in specified server.

Returns number

import

import(sid: SID, key: string, value: string, cb: function): void

Inherited from SessionService.import
- Defined in common/service/sessionService.ts:257
Import the key/value into session.

api

private

Parameters
- sid: SID
- key: string
- value: string
- cb: function
  - - (err?: Error, result?: void): void
    - Parameters
      - Optional err: Error
      - Optional result: void
      Returns void
Returns void

importAll

importAll(sid: SID, settings: object, cb: function): void

Inherited from SessionService.importAll
- Defined in common/service/sessionService.ts:275
Import new value for the existed session.

memberof

SessionService

api

private

Parameters
- sid: SID
- settings: object
  - [key: string]: any
- cb: function
  - - (err?: Error, result?: void): void
    - Parameters
      - Optional err: Error
      - Optional result: void
      Returns void
Returns void

kick

kick(uid: UID, reason?: string, cb?: function): void

Inherited from SessionService.kick
- Defined in common/service/sessionService.ts:299
Kick all the session offline under the user id.

memberof

SessionService

Parameters
- uid: UID
  
  user id asscociated with the session
- Optional reason: string
- Optional cb: function
  
  callback function
  - - (err?: Error, result?: void): void
    - Parameters
      - Optional err: Error
      - Optional result: void
      Returns void
Returns void

kickBySessionId

kickBySessionId(sid: SID, reason?: string, cb?: function): void

Inherited from SessionService.kickBySessionId
- Defined in common/service/sessionService.ts:345
Kick a user offline by session id.

memberof

SessionService

Parameters
- sid: SID
  
  session id
- Optional reason: string
- Optional cb: function
  
  callback function
  - - (err?: Error, result?: void): void
    - Parameters
      - Optional err: Error
      - Optional result: void
      Returns void
Returns void

remove

remove(sid: SID): void

Inherited from SessionService.remove
- Defined in common/service/sessionService.ts:223
Remove session by key.

memberof

SessionService

api

private

Parameters
- sid: SID
  
  The session id
Returns void

sendMessage

sendMessage(sid: SID, msg: any): boolean

Inherited from SessionService.sendMessage
- Defined in common/service/sessionService.ts:402
Send message to the client by session id.

memberof

SessionService

api

private

Parameters
- sid: SID
  
  session id
- msg: any
  
  message to send
Returns boolean

sendMessageByUid

sendMessageByUid(uid: UID, msg: any): boolean

Inherited from SessionService.sendMessageByUid
- Defined in common/service/sessionService.ts:424
Send message to the client by user id.

memberof

SessionService

api

private

Parameters
- uid: UID
  
  userId
- msg: any
  
  message to send
Returns boolean

unbind

unbind(sid: SID, uid: UID, cb: function): void

Inherited from SessionService.unbind
- Defined in common/service/sessionService.ts:139
Unbind a session with the user id.

memberof

SessionService

api

private

Parameters
- sid: SID
- uid: UID
- cb: function
  - - (err?: Error, result?: void): void
    - Parameters
      - Optional err: Error
      - Optional result: void
      Returns void
Returns void