Class WSMailBox

Hierarchy

EventEmitter
- WSMailBox

Index

Constructors

constructor

Properties

Constructors

constructor

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

- Defined in rpc-client/mailboxes/ws-mailbox.ts:47
Parameters
- server: object
  - host: Function
  - id: number
  - port: string
- opts: MailBoxOpts
Returns WSMailBox

Properties

_interval

_interval: any

bufferMsg

bufferMsg: any

closed

closed: boolean = false

connected

connected: boolean = false

curId

curId: number = 0

host

host: Function

id

id: number

interval

interval: number

opts

opts: any

port

port: string

queue

queue: Array<any> = []

requests

requests: object

Type declaration

[key: string]: any

socket

socket: any

timeout

timeout: object

Type declaration

[key: string]: any

timeoutValue

timeoutValue: number

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

clearCbTimeout

clearCbTimeout(mailbox: WSMailBox, id: number): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:266
Parameters
- mailbox: WSMailBox
- id: number
Returns void

close

close(): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:130
Returns void

connect

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

- Defined in rpc-client/mailboxes/ws-mailbox.ts:61
Parameters
- tracer: Tracer
- cb: function
  - - (parameters?: Error): void
    - Parameters
      - Optional parameters: Error
      Returns void
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(mailbox: WSMailBox, msg: Msg): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:201
Parameters
- mailbox: WSMailBox
- msg: Msg
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(mailbox: WSMailBox): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:206
Parameters
- mailbox: WSMailBox
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(mailbox: WSMailBox, pkg: MailBoxPkg): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:224
Parameters
- mailbox: WSMailBox
- pkg: MailBoxPkg
Returns void

processMsgs

processMsgs(mailbox: WSMailBox, pkgs: Array<MailBoxPkg>): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:216
Parameters
- mailbox: WSMailBox
- 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: Msg, opts: MailBoxOpts, cb: function): void

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

Parameters
- tracer: Tracer
- msg: Msg
- opts: MailBoxOpts
  
  attach info to send method
- cb: function
  
  declaration decided by remote interface
  - - (tracer: Tracer, msg?: any, cb?: Function): void
    - Parameters
      - tracer: Tracer
      - Optional msg: any
      - Optional cb: Function
      Returns void
Returns void

setCbTimeout

setCbTimeout(mailbox: WSMailBox, id: number, tracer: Tracer, cb: function): void

- Defined in rpc-client/mailboxes/ws-mailbox.ts:250
Parameters
- mailbox: WSMailBox
- id: number
- tracer: Tracer
- cb: function
  - - (tracer: Tracer, msg?: any, cb?: Function): void
    - Parameters
      - tracer: Tracer
      - Optional msg: any
      - Optional cb: Function
      Returns void
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