Session | pinus

Session maintains the relationship between client connection and user information. There is a session associated with each client connection. And it should bind to a user id after the client passes the identification.

Session is created in frontend server and should not be accessed in handler. There is a proxy class called BackendSession in backend servers and FrontendSession in frontend servers.

Hierarchy

EventEmitter
- Session

Index

Constructors

constructor

Properties

Constructors

constructor

new Session(sid: SID, frontendId: FRONTENDID, socket: ISocket, service: SessionService): Session

- Defined in common/service/sessionService.ts:520
Parameters
- sid: SID
- frontendId: FRONTENDID
- socket: ISocket
- service: SessionService
Returns Session

Properties

Private _sessionService

___sessionService__: SessionService

_socket

___socket__: any

Private _state

___state__: number

frontendId

frontendId: FRONTENDID

id

id: SID

settings

settings: object

Type declaration

[key: string]: any

uid

uid: UID

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:907
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

bind

bind(uid: UID): void

- Defined in common/service/sessionService.ts:552
Bind the session with the the uid.

api

public

Parameters
- uid: UID
  
  User id
Returns void

closed

closed(reason: string): void

- Defined in common/service/sessionService.ts:642
Closed callback for the session which would disconnect client in next tick.

api

public

Parameters
- reason: string
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:917
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:918
Returns Array<string | symbol>

get

get(key: string): any

- Defined in common/service/sessionService.ts:612
Get value from the session.

api

public

Parameters
- key: string
  
  session key
Returns any

value associated with session key

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:915
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:919
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:916
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:908
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:909
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:910
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:911
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

remove

remove(key: string): void

- Defined in common/service/sessionService.ts:600
Remove value from the session.

api

public

Parameters
- key: string
  
  session key
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:913
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:912
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(msg: any): void

- Defined in common/service/sessionService.ts:622
Send message to the session.

Parameters
- msg: any
  
  final message sent to client
Returns void

sendBatch

sendBatch(msgs: any[]): void

- Defined in common/service/sessionService.ts:632
Send message to the session in batch.

Parameters
- msgs: any[]
  
  list of message
Returns void

set

set(values: object): void
set(key: string, value: any): void

- Defined in common/service/sessionService.ts:577
Set values (one or many) for the session.

api

public

Parameters
- values: object
  - [key: string]: any
Returns void
- Defined in common/service/sessionService.ts:578
Parameters
- key: string
- value: any
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:914
Parameters
- n: number
Returns this

toFrontendSession

toFrontendSession(): FrontendSession

- Defined in common/service/sessionService.ts:541
Returns FrontendSession

unbind

unbind(uid: UID): void

- Defined in common/service/sessionService.ts:564
Unbind the session with the the uid.

api

private

Parameters
- uid: UID
  
  User id
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in C:/pinus/pinus/node_modules/@types/node/index.d.ts:904
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sid: SID

frontendId: FRONTENDID

socket: ISocket

service: SessionService

Returns Session

Properties

Private ___sessionService__

___socket__

Private ___state__

frontendId

id

settings

Type declaration

[key: string]: any

uid

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

bind

Parameters

uid: UID

Returns void

closed

Parameters

reason: string

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

get

Parameters

key: string

Returns any

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

on

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

once

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

prependListener

Parameters

Private _sessionService

_socket

Private _state