Class MailBox

Hierarchy

EventEmitter
- MailBox

Index

Constructors

constructor

Properties

Constructors

constructor

new MailBox(server: object, opts: MailBoxOpts): MailBox

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:39
Parameters
- server: object
  - host: string
  - id: string
  - port: number
- opts: MailBoxOpts
Returns MailBox

Properties

_interval

_interval: Timer

bufferMsg

bufferMsg: boolean

closed

closed: boolean = false

connected

connected: boolean = false

curId

curId: number = 0

host

host: string

id

id: string

interval

interval: number

keepalive

keepalive: number

keepaliveTimer

keepaliveTimer: Timer

lastPing

lastPing: number = -1

lastPong

lastPong: number = -1

opts

opts: any

port

port: number

queue

queue: MailBoxMessage[] = []

requests

requests: object

Type declaration

[id: number]: MailBoxTimeoutCallback

serverId

serverId: string

socket

socket: any

timeout

timeout: object

Type declaration

[id: number]: Timer

timeoutValue

timeoutValue: 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

checkKeepAlive

checkKeepAlive(): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:249
Returns void

clearCbTimeout

clearCbTimeout(id: number): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:352
Parameters
- id: number
Returns void

close

close(): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:169
close mailbox

Returns void

connect

connect(tracer: Tracer, cb: function): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:80
Parameters
- tracer: Tracer
- cb: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

doSend

doSend(socket: any, msg: object): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:296
Parameters
- socket: any
- msg: object
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

enqueue

enqueue(msg: MailBoxMessage): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:281
Parameters
- msg: MailBoxMessage
Returns void

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>

flush

flush(): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:286
Returns void

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

processMsg

processMsg(pkg: MailBoxPkg): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:312
Parameters
- pkg: MailBoxPkg
Returns void

processMsgs

processMsgs(pkgs: Array<MailBoxPkg>): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:304
Parameters
- pkgs: Array<MailBoxPkg>
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(tracer: Tracer, msg: MailBoxMessage, opts: any, cb: MailBoxTimeoutCallback): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:192
send message to remote server

Parameters
- tracer: Tracer
- msg: MailBoxMessage
- opts: any
  
  attach info to send method
- cb: MailBoxTimeoutCallback
  
  declaration decided by remote interface
Returns void

setCbTimeout

setCbTimeout(id: number, tracer: any, cb: Function): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:335
Parameters
- id: number
- tracer: any
- cb: Function
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

setupKeepAlive

setupKeepAlive(): void

- Defined in rpc-client/mailboxes/mqtt-mailbox.ts:240
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