← hyperlink-ts

Lookup35

Constructors

adviseconstPublish placement advice (requires Advice in context).clearAdviceconstClear placement advice for a HyperService (Tag or wire key).nodesServingconstList directory rows that advertise a HyperService (Tag or wire key).preferconstPrefer nodeKey when dialing a HyperService (Tag or wire key).preferEntryconstPrefer a directory row's nodeKey for a HyperService.preferredconstRead preferred directory nodeKey for a HyperService (Tag or wire key).

Layers & Serving

directoryAdvertiseLayerconstSoft directory advertise for Node.unix / Node.http / Node.ws: when Directory is in the environment, register node with the given serves keys and unregister on scope close.layerconstSame-machine default Lookup — layerOptions() on defaultIpcPath.layerIpcconstServe Identity + Directory + Advice on a Unix-domain path.layerNodeconstServe Lookup exclusively on an addressed Node.Lookup (ipc { path } in v1).layerOptionsconstBind-or-dial a same-machine Lookup path (L1 / D7).

Services

AdviceclassLookup placement board — coordinator advice for nodeless / Hyperlink.lookupClient dial.DirectoryclassLookup node directory — advertise / unregister / list by served HyperService key.IdentityclassLookup identity service — claim HyperService keys (first wins; dead winners replaceable).

Clients

clientconstClient for Identity + Directory via an ipc LookupNode.clientOptionsconstDial the same-machine Lookup path (defaultIpcPath or options.path).

Models

OnConflicttypeDirectory advertise conflict policy when the same nodeKey already has a row.OnConflictResolvedtypeConcrete advertise conflict policy (no "inherit") — what Lookup runs.ServicestypeServices a Lookup client layer provides — identity, directory, and placement advice.

Wire Schemas

AdvertiseRequestclassAdvertise / refresh a directory row.AdviseRequestclassPlacement advice — prefer this directory nodeKey when dialing serviceKey.ClaimRequestclassClaim payload — hyperlink identity key plus the claimant's endpoint.ClearAdviceRequestclassClear placement advice for a HyperService key.DirectoryEntryclassDirectory row — dial target plus HyperService keys this node serves (listen catalog).EndpointclassWhere a winning claimant / advertised node lives — node key + transport address.NodesServingRequestclassList nodes that advertised a given HyperService key in serves.PreferredRequestclassRead the preferred directory nodeKey for a HyperService (if any).ResolveRequestclassResolve payload — look up a winning claim by HyperService key (nodeless clients).UnregisterRequestclassUnregister payload — remove a directory row by nodeKey.

Utils

defaultIpcPathconstWell-known Unix socket path for same-machine default lookup (L1).kindconstCanonical kind stamped on Lookup HyperServices.resolveOnConflictconstWalk preference layers (first concrete wins).

Errors

DuplicateIdentityclassAnother process already owns this HyperService key — original is where to dial.IncumbentAliveclassAdvertise rejected — an incumbent with the same nodeKey still answers a node-handle ping.LookupUnaddressedclassLookup node has no dialable address — need { path } / url, or use layer / layerOptions.