Options
All
  • Public
  • Public/Protected
  • All
Menu

pinus-admin

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Application

Application: any

Callback

Callback: function

Type declaration

    • (err?: Error | string, body?: any): void
    • Parameters

      • Optional err: Error | string
      • Optional body: any

      Returns void

ConsoleServiceOpts

Listener

Listener: function

Type declaration

    • (...args: any[]): void
    • Parameters

      • Rest ...args: any[]

      Returns void

MasterCallback

MasterCallback: function

Type declaration

    • (err?: string, data?: any): void
    • Parameters

      • Optional err: string
      • Optional data: any

      Returns void

MonitorCallback

MonitorCallback: function

Type declaration

    • (err?: Error, data?: any): void
    • Parameters

      • Optional err: Error
      • Optional data: any

      Returns void

RequestMsg

RequestMsg: object & any

WhiteList

WhiteList: string[]

Variables

CPUProfileType

CPUProfileType: string = "CPU"

DEFAULT_DELAY

DEFAULT_DELAY: number = 10

DEFAULT_INTERVAL

DEFAULT_INTERVAL: number = 5 * 60

HeapProfileType

HeapProfileType: string = "HEAP"

MS_OF_SECOND

MS_OF_SECOND: number = 1000

PRO_FAIL

PRO_FAIL: PRO_CODE = PRO_CODE.FAIL

PRO_OK

PRO_OK: PRO_CODE = PRO_CODE.OK

STATUS_INTERVAL

STATUS_INTERVAL: number = 5 * 1000

ST_CLOSED

ST_CLOSED: number = 3

ST_CONNECTED

ST_CONNECTED: number = 2

ST_INITED

ST_INITED: number = 1

ST_REGISTERED

ST_REGISTERED: number = 3

ST_STARTED

ST_STARTED: number = 2

TYPE_CLIENT

TYPE_CLIENT: string = "client"

TYPE_MONITOR

TYPE_MONITOR: string = "monitor"

curId

curId: number = 1

logger

logger: Logger = getLogger('pinus-admin', __filename)

moduleError

moduleError: number

profiler

profiler: any = null

Functions

aclControl

  • aclControl(agent: MasterAgent, action: string, method: string, moduleId: string, msg: any): 1 | 0 | "Unknow clientId" | "Command permission denied" | "Client info error"
  • Parameters

    • agent: MasterAgent
    • action: string
    • method: string
    • moduleId: string
    • msg: any

    Returns 1 | 0 | "Unknow clientId" | "Command permission denied" | "Client info error"

addToSchedule

checkFilePath

  • checkFilePath(filepath: string, force: boolean, cb: function): void
  • Parameters

    • filepath: string
    • force: boolean
    • cb: function
        • (result: string): void
        • Parameters

          • result: string

          Returns void

    Returns void

checkJSON

  • checkJSON(obj: any): boolean

clone

  • clone(param: any, obj: any): any

cloneError

  • cloneError(origin: any): any

compareServer

composeCommand

  • composeCommand(id: number, command: string, moduleId: string, body: any): string
  • Parameters

    • id: number
    • command: string
    • moduleId: string
    • body: any

    Returns string

composeRequest

  • composeRequest(id: number, moduleId: string, body: any): string | object
  • Parameters

    • id: number
    • moduleId: string
    • body: any

    Returns string | object

composeResponse

  • composeResponse(req: object, err: string | Error, res: any): string
  • Parameters

    • req: object
      • reqId: number
    • err: string | Error
    • res: any

    Returns string

createCountDownLatch

createMasterConsole

createMonitorConsole

  • Create monitor ConsoleService

    Parameters

    • opts: ConsoleServiceOpts

      construct parameter opts.type {String} server type, 'master', 'connector', etc. opts.id {String} server id opts.host {String} master server host opts.port {String | Number} master port

    Returns ConsoleService

defaultAuthServerMaster

  • defaultAuthServerMaster(msg: object, env: string, cb: function): void
  • Parameters

    • msg: object
      • id: string
      • serverType: string
      • token: string
    • env: string
    • cb: function
        • (result: "ok" | "bad"): void
        • Parameters

          • result: "ok" | "bad"

          Returns void

    Returns void

defaultAuthServerMonitor

  • defaultAuthServerMonitor(msg: object, env: string, cb: function): void
  • Parameters

    • msg: object
      • id: string
      • serverType: string
    • env: string
    • cb: function
        • (result: "ok" | "bad"): void
        • Parameters

          • result: "ok" | "bad"

          Returns void

    Returns void

defaultAuthUser

  • defaultAuthUser(msg: object, env: string, cb: function): void

disableApp

disableCommand

doScheduleJob

  • doScheduleJob(args: object): void

dumpCPU

  • Parameters

    • handle: HandleType
    • _agent: MonitorAgent | MasterAgent
    • comd: string
    • context: string
    • param: object
      • filepath: string
      • force: boolean
      • times: number
    • cb: function
        • (err?: Error | string, data?: any): void
        • Parameters

          • Optional err: Error | string
          • Optional data: any

          Returns void

    Returns void

dumpMemory

  • Parameters

    • handle: HandleType
    • _agent: MonitorAgent | MasterAgent
    • comd: string
    • context: string
    • param: object
      • filepath: string
      • force: boolean
    • cb: function
        • (err?: Error | string, data?: any): void
        • Parameters

          • Optional err: Error | string
          • Optional data: any

          Returns void

    Returns void

enableApp

enableCommand

exportEvent

fetchLogs

  • fetchLogs(root: string, msg: any, callback: function): void
  • Parameters

    • root: string
    • msg: any
    • callback: function
        • (data: object): void
        • Parameters

          • data: object
            • dataArray: any
            • logfile: string

          Returns void

    Returns void

format

  • format(date: Date, format?: string): string
  • Parameters

    • date: Date
    • Optional format: string

    Returns string

get

getApp

getComponentName

  • getComponentName(c: string): string

getLogFileName

  • getLogFileName(logfile: string, serverId: string): string

handlerCb

invokeCallback

  • invokeCallback(cb: Function, ...args: any[]): void
  • Check and invoke callback

    Parameters

    • cb: Function
    • Rest ...args: any[]

    Returns void

isRequest

  • isRequest(msg: any): any

list

listCommand

md5

  • md5(str: string): string

parse

  • parse(msg: any): any

proxyCb

registerRecord

run

runScript

save

setApp

showComponents

showConfig

showConnections

showError

showHandler

showLogins

showModules

showProxy

showServers

showSettings

showStatus

size

  • size(obj: any, type?: string): number
  • Get the count of elements of object

    Parameters

    • obj: any
    • Optional type: string

    Returns number

Object literals

DEFAULT_PARAM

DEFAULT_PARAM: object

KEEPALIVE

KEEPALIVE: number = 60 * 1000

RECONNECT_DELAY

RECONNECT_DELAY: number = 1 * 1000

RECONNECT_DELAY_MAX

RECONNECT_DELAY_MAX: number = 60 * 1000

TIMEOUT

TIMEOUT: number = 5 * 1000