Class RpcRegistry

Global RPC registry for storing all known RPC registrations.

Note

All RPC methods are registered here at startup. The registry is used by the replication manager to resolve method paths to handlers.

Index

Constructors

Methods

Constructors

constructor

new RpcRegistry(): RpcRegistry
Returns RpcRegistry

Methods

`Static`find

find(path): RpcRegistration
Finds an RPC registration by path.
Parameters
- path: string
  The method path to look up.
Returns RpcRegistration
Pointer to the registration, or nullptr if not found.

`Static`register

register(path, func, scope, reliable, scriptModule): boolean
Registers an RPC method with individual parameters.
Parameters
- path: string
  The method path for routing RPC calls.
- func: ((arguments_: MemoryDataStream) => void)
  The handler function to invoke.
  - - (arguments_): void
    - Parameters
      arguments_: MemoryDataStream
      Returns void
- scope: EnumValue<RpcScope, number>
  The default scope of the call.
- reliable: boolean
  If true, the RPC must be delivered reliably.
- scriptModule: string
  The script module that registered this RPC.
Returns boolean
True if the registration was successful, false otherwise.

Note
The path must be unique. Duplicate registrations will log an error.