Class ConsoleService

ConsoleService Constructor

class: ConsoleService
constructor
param: construct parameter opts.type {String} server type, 'master', 'connector', etc. opts.id {String} server id opts.host {String} (monitor only) master server host opts.port {String | Number} listen port for master or master port for monitor opts.master {Boolean} current service is master or monitor opts.info {Object} more server info for current server, {id, serverType, host, port}
api: public

Hierarchy

EventEmitter
- ConsoleService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConsoleService(_opts: ConsoleServiceOpts): ConsoleService

- Defined in consoleService.ts:114
Parameters
- _opts: ConsoleServiceOpts
Returns ConsoleService

Properties

agent

agent: MasterAgent | MonitorAgent

authServer

authServer: defaultAuthServerMonitor

authUser

authUser: defaultAuthUser

commands

commands: object

Type declaration

[key: string]: function
- - (consoleService: ConsoleService, moduleId: string, msg: any, cb: Callback): void
  - Parameters
    - consoleService: ConsoleService
    - moduleId: string
    - msg: any
    - cb: Callback
    Returns void

env

env: string

host

host: string

id

id: string

master

master: boolean

modules

modules: object

Type declaration

[key: string]: ModuleRecord

port

port: number

type

type: string

values

values: object

Type declaration

[key: string]: any

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

command

command(command: string, moduleId: string, msg: any, cb: function): void

- Defined in consoleService.ts:321
Parameters
- command: string
- moduleId: string
- msg: any
- cb: function
  - - (err?: Error | string, msg?: any): void
    - Parameters
      - Optional err: Error | string
      - Optional msg: any
      Returns void
Returns void

disable

disable(moduleId: string): boolean

- Defined in consoleService.ts:246
disable adminConsole module

api

public

Parameters
- moduleId: string
  
  adminConsole id/name
Returns boolean

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

enable

enable(moduleId: string): boolean

- Defined in consoleService.ts:228
enable adminConsole module

api

public

Parameters
- moduleId: string
  
  adminConsole id/name
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>

execute

execute(moduleId: string, method: string, msg: any, cb: function): void

- Defined in consoleService.ts:271
call concrete module and handler(monitorHandler,masterHandler,clientHandler)

api

public

Parameters
- moduleId: string
  
  adminConsole id/name
- method: string
  
  handler
- msg: any
  
  message
- cb: function
  
  callback function
  - - (err?: Error | string, msg?: any): void
    - Parameters
      - Optional err: Error | string
      - Optional msg: any
      Returns void
Returns void

get

get(moduleId: string): any

- Defined in consoleService.ts:369
get module data from map

api

public

Parameters
- moduleId: string
  
  adminConsole id/name
Returns any

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

register

register(moduleId: string, module: IModule): void

- Defined in consoleService.ts:217
register a new adminConsole module

api

public

Parameters
- moduleId: string
  
  adminConsole id/name
- module: IModule
  
  module object
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

set

set(moduleId: string, value: any): void

- Defined in consoleService.ts:358
set module data to a map

api

public

Parameters
- moduleId: string
  
  adminConsole id/name
- value: any
  
  module data
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

start

start(cb: function): void

- Defined in consoleService.ts:160
start master or monitor

api

public

Parameters
- cb: function
  
  callback function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

stop

stop(): void

- Defined in consoleService.ts:201
stop console modules and stop master server

api

public

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