Class RpcRegistration

Metadata describing an RPC method registration.

Note

Metadata is generated at compile time (C++) or decoration time (TS) and stored in reflection. It tells the RPC manager how to route and deliver a method call.

Index

Constructors

Properties

_path _reliable _scope

Accessors

path reliable scope

Methods

clone isEqual isEqual

Constructors

constructor

new RpcRegistration(
    path?: string,
    scope?: EnumValue<RpcScope>,
    reliable?: boolean,
): RpcRegistration
Parameters
- Optionalpath: string
- Optionalscope: EnumValue<RpcScope>
- Optionalreliable: boolean
Returns RpcRegistration

Properties

`Protected`_path

_path: string

`Protected`_reliable

_reliable: boolean

`Protected`_scope

_scope: EnumValue<RpcScope>

Accessors

path

get path(): string

Path of the method on the target.

Returns string

Note
Required to map incoming calls to the correct method. The path supports targeting RPC calls on sub-objects.

reliable

get reliable(): boolean

If true, the RPC must be delivered reliably.

Returns boolean

Note
Reliable calls guarantee delivery and ordering. Unreliable calls may be dropped if the connection is congested, which is acceptable for transient signals like cosmetic effects.

scope

get scope(): EnumValue<RpcScope>

The default scope of the call.

Returns EnumValue<RpcScope>

Note
Can be overridden at runtime when sending.

Methods

clone

clone(): RpcRegistration

Clones this instance and returns a new RpcRegistration with identical values.

Returns RpcRegistration

isEqual

isEqual(
this: Immutable<RpcRegistration>,
other: Immutable<RpcRegistration>,
): boolean
Determines if this RpcRegistration instance is equal to the other instance.
Parameters
- this: Immutable<RpcRegistration>
- other: Immutable<RpcRegistration>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<RpcRegistration>,
rhs: Immutable<RpcRegistration>,
): boolean
Determines if both RpcRegistration instances are equal.
Parameters
- lhs: Immutable<RpcRegistration>
- rhs: Immutable<RpcRegistration>
Returns boolean