Skip to content

HostedProtocol

Defined in: src/client/introspect.ts:385

One protocol a server hosts, as vgi_rpc.Reflection.v1 lists it.

Returned by listProtocols in the server’s order: application protocols in registration order (the primary first), then the framework’s own (vgi_rpc.Reflection.v1, and vgi_rpc.Identity.v1 on an HTTP server that hosts it). Frozen.

readonly deprecated: boolean;

Defined in: src/client/introspect.ts:397

Whether callers should migrate off this protocol. Default false.


readonly deprecationMessage: string;

Defined in: src/client/introspect.ts:399

What to migrate to; "" unless deprecated.


readonly features: readonly string[];

Defined in: src/client/introspect.ts:401

Capability tokens the protocol announces. Default empty.


readonly hash: string;

Defined in: src/client/introspect.ts:395

SHA-256 of its canonical description, as 64 lowercase hex characters. Equal hashes mean an identical wire surface in any port, so a caller holding a cached description for this hash can skip describeProtocol.


readonly name: string;

Defined in: src/client/introspect.ts:388

The protocol’s wire name – its routing key, carrying its major version, e.g. "vgi_rpc.Reflection.v1".


readonly version: string;

Defined in: src/client/introspect.ts:390

Its declared semver, or "" when it declares none.