MasterAgent | pinus-admin

MasterAgent Constructor

class: MasterAgent
constructor
param: construct parameter opts.consoleService {Object} consoleService opts.id {String} server id opts.type {String} server type, 'master', 'connector', etc. opts.socket {Object} socket-io object opts.reqId {Number} reqId add by 1 opts.callbacks {Object} callbacks opts.state {Number} MasterAgent state
api: public

Hierarchy

EventEmitter
- MasterAgent

Index

Constructors

constructor

Properties

Constructors

constructor

new MasterAgent(consoleService: ConsoleService, opts: MasterAgentOptions): MasterAgent

- Defined in master/masterAgent.ts:68
Parameters
- consoleService: ConsoleService
- opts: MasterAgentOptions
Returns MasterAgent

Properties

callbacks

callbacks: object

Type declaration

[reqId: number]: Callback

clients

clients: object

Type declaration

[id: string]: AgentClient

consoleService

consoleService: ConsoleService

idMap

idMap: object

Type declaration

[serverId: string]: AgentClient

msgMap

msgMap: object

Type declaration

[serverId: string]: object
- [reqId: number]: object
  - moduleId: string
  - msg: any

reqId

reqId: number = 1

server

server: MqttServer = null

slaveMap

slaveMap: object

Type declaration

[serverId: string]: AgentClient[]

sockets

sockets: object

Type declaration

[id: string]: mqtt_connection

state

state: number = ST_INITED

typeMap

typeMap: object

Type declaration

[type: string]: AgentClient[]

whitelist

whitelist: WhiteList

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addConnection

addConnection(id: string, type: string, pid: string, info: AdminUserInfo | ServerInfo, socket: MqttSocket): AgentClient

- Defined in master/masterAgent.ts:563
add monitor,client to connection -- idMap

api

private

Parameters
- id: string
- type: string
  
  serverType
- pid: string
- info: AdminUserInfo | ServerInfo
- socket: MqttSocket
  
  socket-io object
Returns AgentClient

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

broadcastCommand

broadcastCommand(records: AgentClient[] | object, command: string, moduleId: string, msg: any): void

- Defined in master/masterAgent.ts:718
Parameters
- records: AgentClient[] | object
- command: string
- moduleId: string
- msg: any
Returns void

broadcastMonitors

broadcastMonitors(records: object | AgentClient[], moduleId: string, msg: any): void

- Defined in master/masterAgent.ts:696
broadcast msg to monitor

api

private

Parameters
- records: object | AgentClient[]
- moduleId: string
  
  module id/name
- msg: any
  
  message
Returns void

close

close(): void

- Defined in master/masterAgent.ts:168
close master agent

api

public

Returns void

doAuthServer

doAuthServer(msg: AuthServerRequest, socket: MqttSocket, cb: Callback): void

- Defined in master/masterAgent.ts:524
Parameters
- msg: AuthServerRequest
- socket: MqttSocket
- cb: Callback
Returns void

doAuthUser

doAuthUser(msg: AuthUserRequest, socket: MqttSocket, cb: Callback): void

- Defined in master/masterAgent.ts:470
Parameters
- msg: AuthUserRequest
- socket: MqttSocket
- cb: Callback
Returns void

doSend

doSend(socket: MqttSocket, topic: string, msg: any): void

- Defined in master/masterAgent.ts:683
Parameters
- socket: MqttSocket
- topic: string
- msg: any
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(moduleId: string): any

- Defined in master/masterAgent.ts:196
get module

api

public

Parameters
- moduleId: string
  
  module id/name
Returns any

getClientById

getClientById(clientId: string): AgentClient

- Defined in master/masterAgent.ts:207
getClientById

api

public

Parameters
- clientId: string
Returns AgentClient

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

listen

listen(port: number, cb: function): void

- Defined in master/masterAgent.ts:83
master listen to a port and handle register and request

api

public

Parameters
- port: number
- cb: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
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[]

notifyAll

notifyAll(moduleId: string, msg?: any): boolean

- Defined in master/masterAgent.ts:427
notify all the monitors without callback

api

public

Parameters
- moduleId: string
  
  module id/name
- Optional msg: any
Returns boolean

notifyById

notifyById(serverId: string, moduleId: string, msg: any): boolean

- Defined in master/masterAgent.ts:309
notify a monitor{master node} by id without callback

api

public

Parameters
- serverId: string
- moduleId: string
  
  module id/name
- msg: any
Returns boolean

notifyByServer

notifyByServer(serverId: string, serverInfo: ServerInfo, moduleId: string, msg: any): boolean

- Defined in master/masterAgent.ts:337
notify a monitor by server{host:port} without callback

api

public

Parameters
- serverId: string
- serverInfo: ServerInfo
- moduleId: string
  
  module id/name
- msg: any
Returns boolean

notifyByType

notifyByType(type: string, moduleId: string, msg: any): boolean

- Defined in master/masterAgent.ts:403
notify monitors by type without callback

api

public

Parameters
- type: string
  
  serverType
- moduleId: string
  
  module id/name
- msg: any
Returns boolean

notifyClient

notifyClient(clientId: string, moduleId: string, msg: any): boolean

- Defined in master/masterAgent.ts:445
notify a client by id without callback

api

public

Parameters
- clientId: string
- moduleId: string
  
  module id/name
- msg: any
Returns boolean

notifyCommand

notifyCommand(command: string, moduleId: string, msg: any): boolean

- Defined in master/masterAgent.ts:461
Parameters
- command: string
- moduleId: string
- msg: any
Returns boolean

notifySlavesById

notifySlavesById(serverId: string, moduleId: string, msg: any): boolean

- Defined in master/masterAgent.ts:377
notify slaves by id without callback

api

public

Parameters
- serverId: string
- moduleId: string
  
  module id/name
- msg: any
Returns boolean

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

removeConnection

removeConnection(id: string, type: string, info: ServerInfo): void

- Defined in master/masterAgent.ts:599
remove monitor,client connection -- idMap

api

private

Parameters
- id: string
- type: string
  
  serverType
- info: ServerInfo
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

request

request(serverId: string, moduleId: string, msg: any, cb: function): boolean

- Defined in master/masterAgent.ts:221
request monitor{master node} data from monitor

api

public

Parameters
- serverId: string
- moduleId: string
  
  module id/name
- msg: any
- cb: function
  - - (errOrResult?: Error | any, body?: any): void
    - Parameters
      - Optional errOrResult: Error | any
      - Optional body: any
      Returns void
Returns boolean

requestServer

requestServer(serverId: string, serverInfo: ServerInfo, moduleId: string, msg: any, cb: Callback): boolean

- Defined in master/masterAgent.ts:265
request server data from monitor by serverInfo{host:port}

api

public

Parameters
- serverId: string
- serverInfo: ServerInfo
- moduleId: string
  
  module id/name
- msg: any
- cb: Callback
Returns boolean

sendToClient

sendToClient(socket: MqttSocket, reqId: number, moduleId: string, msg: any): void

- Defined in master/masterAgent.ts:678
send msg to client

api

private

Parameters
- socket: MqttSocket
  
  socket-io object
- reqId: number
  
  request id
- moduleId: string
  
  module id/name
- msg: any
  
  message
Returns void

sendToMonitor

sendToMonitor(socket: MqttSocket, reqId: number, moduleId: string, msg: any): void

- Defined in master/masterAgent.ts:664
send msg to monitor

api

private

Parameters
- socket: MqttSocket
  
  socket-io object
- reqId: number
  
  request id
- moduleId: string
  
  module id/name
- msg: any
  
  message
Returns void

set

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

- Defined in master/masterAgent.ts:185
set module

api

public

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

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

consoleService: ConsoleService

opts: MasterAgentOptions

Returns MasterAgent

Properties

callbacks

Type declaration

[reqId: number]: Callback

clients

Type declaration

[id: string]: AgentClient

consoleService

idMap

Type declaration

[serverId: string]: AgentClient

msgMap

Type declaration

[serverId: string]: object

[reqId: number]: object

moduleId: string

msg: any

reqId

server

slaveMap

Type declaration

[serverId: string]: AgentClient[]

sockets

Type declaration

[id: string]: mqtt_connection

state

typeMap

Type declaration

[type: string]: AgentClient[]

whitelist

Static defaultMaxListeners

Methods

addConnection

Parameters

id: string

type: string

pid: string

info: AdminUserInfo | ServerInfo

socket: MqttSocket

Returns AgentClient

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

broadcastCommand

Parameters

records: AgentClient[] | object

command: string

moduleId: string

msg: any

Returns void

broadcastMonitors

Parameters

records: object | AgentClient[]

moduleId: string

msg: any

Returns void

close

Returns void

doAuthServer

Parameters

msg: AuthServerRequest

socket: MqttSocket

cb: Callback

Returns void