Class Server

Hierarchy

EventEmitter
- Server

Index

Constructors

constructor

Properties

Constructors

constructor

new Server(app: Application, opts?: ServerOptions): Server

- Defined in server/server.ts:58
Parameters
- app: Application
- Optional opts: ServerOptions
Returns Server

Properties

app

app: Application

cronHandlers

cronHandlers: object = null

Type declaration

[handler: string]: object
- [method: string]: function
  - - (): void
    - Returns void

crons

crons: Cron[] = []

filterService

filterService: FilterService = null

globalFilterService

globalFilterService: FilterService = null

handlerService

handlerService: HandlerService = null

jobs

jobs: object

Type declaration

[cronId: string]: number

opts

opts: ServerOptions

state

state: number = ST_INITED

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addCrons

addCrons(crons: Cron[]): void

- Defined in server/server.ts:172
Add crons at runtime.

Parameters
- crons: Cron[]
  
  would be added in application
Returns void

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

afterStart

afterStart(): void

- Defined in server/server.ts:88
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>

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

globalHandle

globalHandle(msg: any, session: FrontendOrBackendSession, cb: HandlerCallback): void

- Defined in server/server.ts:108
Global handler.

Parameters
- msg: any
  
  request message
- session: FrontendOrBackendSession
  
  session object
- cb: HandlerCallback
Returns void

handle

handle(msg: any, session: FrontendOrBackendSession, cb: HandlerCallback): void

- Defined in server/server.ts:155
Handle request

Parameters
- msg: any
- session: FrontendOrBackendSession
- cb: HandlerCallback
Returns void

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

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

removeCrons

removeCrons(crons: Cron[]): void

- Defined in server/server.ts:188
Remove crons at runtime.

Parameters
- crons: Cron[]
  
  would be removed in application
Returns void

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

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

start

start(): void

- Defined in server/server.ts:73
Server lifecycle callback

Returns void

stop

stop(): void

- Defined in server/server.ts:96
Stop server

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