Class Rpc

Bus RPC layer

Hierarchy

Rpc

Index

Constructors

Properties

blockingFrames blockingNotifications client onCall onFrame? onNotification?

Methods

call call0 isConnected notify

Constructors

constructor

new Rpc(client): Rpc
Parameters
- client: Bus
  Bus client
Returns Rpc
- Defined in node_modules/busrt/dist/busrt.d.ts:198

Properties

blockingFrames

blockingFrames: boolean

blockingNotifications

blockingNotifications: boolean

client

client: Bus

attached bus client

onCall

onCall: ((call) => undefined | Buffer | Promise<undefined | Buffer>)

Type declaration

- (call): undefined | Buffer | Promise<undefined | Buffer>
- Method, called on incoming RPC calls
  Parameters
  - call: RpcEvent
  Returns undefined | Buffer | Promise<undefined | Buffer>

`Optional` onFrame

onFrame?: ((frame) => void | Promise<void>)

Type declaration

- (frame): void | Promise<void>
- Method, called on incoming frames
  Parameters
  - frame: RpcEvent
  Returns void | Promise<void>

`Optional` onNotification

onNotification?: ((notification) => void | Promise<void>)

Type declaration

- (notification): void | Promise<void>
- Method, called on incoming RPC notifications
  Parameters
  - notification: RpcEvent
  Returns void | Promise<void>

Methods

call

call(target, method, params?, qos?): Promise<RpcOpResult>
Performs RPC call
Parameters
- target: string
  RPC target
- method: string
  RPC method on the target
- Optional params: Buffer
- Optional qos: QoS
  QoS
Returns Promise<RpcOpResult>
- Defined in node_modules/busrt/dist/busrt.d.ts:236

call0

call0(target, method, params?, qos?): Promise<OpResult>
Performs RPC call with no reply required
Parameters
- target: string
  RPC target
- method: string
  RPC method on the target
- Optional params: Buffer
- Optional qos: QoS
  QoS
Returns Promise<OpResult>
- Defined in node_modules/busrt/dist/busrt.d.ts:225

isConnected

isConnected(): boolean
Is RPC client connected

Returns boolean
- Defined in node_modules/busrt/dist/busrt.d.ts:204

notify

notify(target, payload?, qos?): Promise<OpResult>
Sends RPC notification
Parameters
- target: string
  notification target
- Optional payload: Buffer
  payload
- Optional qos: QoS
  QoS
Returns Promise<OpResult>
- Defined in node_modules/busrt/dist/busrt.d.ts:214

Generated using TypeDoc