MailStation | pinus-rpc

Mail station constructor.

param: construct parameters

Hierarchy

EventEmitter
- MailStation

Index

Constructors

constructor

Properties

Constructors

constructor

new MailStation(opts?: MailStationOpts): MailStation

- Defined in rpc-client/mailstation.ts:70
Parameters
- Optional opts: MailStationOpts
Returns MailStation

Properties

afters

afters: Array<RpcFilter> = []

befores

befores: Array<RpcFilter> = []

connecting

connecting: object

Type declaration

[serverId: string]: boolean

Optional handleError

handleError: MailStationErrorHandler

mailboxFactory

mailboxFactory: MailBoxFactory

mailboxes

mailboxes: object

Type declaration

[serverId: string]: MailBox

onlines

onlines: object

Type declaration

[serverId: string]: number

opts

opts: MailStationOpts

pendingSize

pendingSize: number

pendings

pendings: object

Type declaration

[serverId: string]: IArguments[]

servers

servers: object

Type declaration

[serverId: string]: RpcServerInfo

serversMap

serversMap: object

Type declaration

[serverType: string]: string[]

state

state: number = STATE_INITED

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

addServer

addServer(serverInfo: RpcServerInfo): void

- Defined in rpc-client/mailstation.ts:142
Add a new server info into the mail station and clear the blackhole associated with the server id if any before.

Parameters
- serverInfo: RpcServerInfo
  
  server info such as {id, host, port}
Returns void

addServers

addServers(serverInfos: Array<RpcServerInfo>): void

- Defined in rpc-client/mailstation.ts:171
Batch version for add new server info.

Parameters
- serverInfos: Array<RpcServerInfo>
  
  server info list
Returns void

after

after(filter: RpcFilter | RpcFilter[]): void

- Defined in rpc-client/mailstation.ts:371
Add after filter

Parameters
- filter: RpcFilter | RpcFilter[]
Returns void

[description]

before

before(filter: RpcFilter | RpcFilter[]): void

- Defined in rpc-client/mailstation.ts:355
Add a before filter

Parameters
- filter: RpcFilter | RpcFilter[]
Returns void

[description]

clearStation

clearStation(): void

- Defined in rpc-client/mailstation.ts:224
Clear station infomation.

Returns void

connect

connect(this: any, tracer: Tracer, serverId: string, cb: Function): void

- Defined in rpc-client/mailstation.ts:400
Try to connect to remote server

Parameters
- this: any
- tracer: Tracer
  
  rpc debug tracer
- serverId: string
- cb: Function
  
  callback function
Returns void

serverId remote server id

dispatch

dispatch(tracer: Tracer, serverId: string, msg: MailBoxMessage, opts: object, cb: function): void

- Defined in rpc-client/mailstation.ts:270
Dispatch rpc message to the mailbox

Parameters
- tracer: Tracer
  
  rpc debug tracer
- serverId: string
  
  remote server id
- msg: MailBoxMessage
  
  rpc invoke message
- opts: object
  
  rpc invoke option args
- cb: function
  
  callback function
  - - (err: Error, ...args: any[]): void
    - Parameters
      - err: Error
      - Rest ...args: any[]
      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

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>

filter

filter(filter: RpcFilter): void

- Defined in rpc-client/mailstation.ts:387
Add before and after filter

Parameters
- filter: RpcFilter
Returns void

[description]

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

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

removeServer

removeServer(this: any, id: string | number): void

- Defined in rpc-client/mailstation.ts:190
Remove a server info from the mail station and remove the mailbox instance associated with the server id.

Parameters
- this: any
- id: string | number
  
  server id
Returns void

removeServers

removeServers(ids: Array<string | number>): void

- Defined in rpc-client/mailstation.ts:207
Batch version for remove remote servers.

Parameters
- ids: Array<string | number>
  
  server id list
Returns void

replaceServers

replaceServers(this: any, serverInfos: Array<RpcServerInfo>): void

- Defined in rpc-client/mailstation.ts:235
Replace remote servers info.

Parameters
- this: any
- serverInfos: Array<RpcServerInfo>
  
  server info list
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 rpc-client/mailstation.ts:87
Init and start station. Connect all mailbox to remote servers.

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

stop

stop(force: boolean): void

- Defined in rpc-client/mailstation.ts:109
Stop station and all its mailboxes

Parameters
- force: boolean
  
  whether stop station forcely
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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: MailStationOpts

Returns MailStation

Properties

afters

befores

connecting

Type declaration

[serverId: string]: boolean

Optional handleError

mailboxFactory

mailboxes

Type declaration

[serverId: string]: MailBox

onlines

Type declaration

[serverId: string]: number

opts

pendingSize

pendings

Type declaration

[serverId: string]: IArguments[]

servers

Type declaration

[serverId: string]: RpcServerInfo

serversMap

Type declaration

[serverType: string]: string[]

state

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

addServer

Parameters

serverInfo: RpcServerInfo

Returns void

addServers

Parameters

serverInfos: Array<RpcServerInfo>

Returns void

after

Parameters

filter: RpcFilter | RpcFilter[]

Returns void

before

Parameters

filter: RpcFilter | RpcFilter[]

Returns void

clearStation

Returns void

connect

Parameters

this: any

tracer: Tracer

serverId: string

cb: Function

Returns void

dispatch

Parameters

tracer: Tracer

serverId: string

msg: MailBoxMessage

opts: object

cb: function

Parameters

err: Error