Référence d'API — @nodefony/http/grpc
stable
Documentation › Référence d’API › @nodefony/http › sous-chemin-grpc
Générée depuis les déclarations de types publiées de
@nodefony/http10.0.0-beta.7 : exactement ce que reçoit une application qui l’installe. Cette page n’existe dans aucun dépôt — pour la corriger, on corrige le TSDoc du code.
@nodefony/http/grpc#
import { … } from "@nodefony/http/grpc" — 8 symboles.
Classes (2)#
GrpcCall#
class GrpcCall implements ContextValues, IRpcCall
Fiche d’un appel gRPC : ce que Nodefony attache à l’appel, et le ContextValues que Connect remet au gestionnaire (ctx.values).
readonly target: object | null— L’objet qui implémente le service pour CET appel : le contrôleur, une instance par appel sous@Scope("request").readonly context: HttpContext | null— Le contexte de la requête qui porte l’appel : l’identité y est lue (authenticatedUser()) sur son magasin, jamais par l’ALS, pour choisir entre 16 et 7 (ADR-0026 D5, D7).constructor(target: object | null, context?: HttpContext | null)get system(): RpcSystem— Le protocole parlé sur le fil : celui du contexte d’appel (grpc,grpc-web,connect) ; à défaut, celui des en-têtes de la requête.get method(): string—paquet.Service/Méthode: le chemin de la route, que l’adaptateur a reconnu à l’octet près.get code(): number | null— Le code de l’appel (0 à 16),nullavantsettle.get codeName(): string | null— Le nom du code (OK,UNAVAILABLE…),nullavec lui.settle(ended: boolean): Error | null— Fixe le code de l’appel auclosede la réponse (ADR-0026 D10 point 2) :get<T>(key: ContextKey<T>): T— Lit une valeur posée par un tiers, ou la valeur par défaut de sa clé.set<T>(key: ContextKey<T>, value: T): this— Pose une valeur pour la durée de l’appel.delete(key: ContextKey<unknown>): this— Retire une valeur ; sa clé rendra de nouveau sa valeur par défaut.expire(): void— Le délai de réponse du serveur est échu : le signal de l’appel s’abaisse (ctx.abort) et l’appel se termine en 4DEADLINE_EXCEEDED, même si le gestionnaire ne lit pas son signal.revoke(): void— L’identité qui a ouvert l’appel n’est plus valable : le signal de l’appel s’abaisse et l’appel se termine en 16UNAUTHENTICATED.shutdown(): void— Le serveur s’arrête : le signal de l’appel s’abaisse et l’appel se termine en 14UNAVAILABLE— le client le rejoue ailleurs (ADR-0026 D8).
GrpcEndpoint#
class GrpcEndpoint<S extends DescService = DescService>
Point d’entrée gRPC d’un service : possède l’adaptateur Connect (connectNodeAdapter) et lui confie la requête et la réponse BRUTES de Node d’un contexte déjà passé par le pipeline (pare-feu, gardes).
readonly service: S— Le contrat servi (descripteur généré parbuf).readonly perCall: boolean— Cible relue à chaque appel (@Scope("request")).constructor(service: S, options?: IGrpcEndpointOptions)serve(context: HttpContext, target: object): void | Promise<void>— Remet la requête du contexte à l’adaptateur, qui écrit lui-même la réponse et ses trailers.
Fonctions (2)#
hasAbort#
function hasAbort(ctx: HandlerContext): ctx is IAbortableHandlerContext
Garde de type : le contexte d’appel porte-t-il abort ? Connect le pose sur tout contexte qu’il crée ; le garde le CONSTATE au lieu de le supposer, pour qu’une version de Connect qui le retirerait se voie à l’exécution (et au test qui le garde) plutôt que par un appel qui ne s’interrompt plus.
markGrpcRoute#
function markGrpcRoute(route: { grpc?: boolean; }): void
Marque une route comme servie par un point d’entrée gRPC — au démarrage, par @nodefony/framework/grpc. Allume la garde qui refuse en 12 une requête gRPC native aboutie à une route qui n’est pas gRPC (ADR-0026 D13 point 3) : tant qu’aucune route n’est marquée, la garde coûte une lecture de booléen.
Interfaces (4)#
IAbortableHandlerContext#
interface IAbortableHandlerContext extends HandlerContext
Le contexte d’appel que Connect remet réellement au gestionnaire : son type public (HandlerContext) ne dit pas abort, que porte pourtant l’objet créé par createHandlerContext (HandlerContextController, non exporté).
abort(reason?: unknown): void— Interrompt l’appel :ctx.signals’abaisse avecreason.
IGrpcEndpointOptions#
interface IGrpcEndpointOptions
Options d’un GrpcEndpoint.
readonly perCall?: boolean—true: la cible change à chaque appel (contrôleur@Scope("request")), chaque méthode la relit dans la fiche d’appel.
IGrpcProtocols#
interface IGrpcProtocols
Protocoles servis — la section grpc de la configuration http (ADR-0026 D3, point 5).
readonly grpc: booleanreadonly grpcWeb: booleanreadonly connect: boolean
IGrpcSettings#
interface IGrpcSettings extends IGrpcProtocols
La section grpc de la configuration http : protocoles servis (D3, point 5) et bornes des messages (D4, points 1, 2 et 6).
readonly readMaxBytes: number— Taille maximale d’un message reçu, après décompression (octets).readonly writeMaxBytes: number— Taille maximale d’un message émis (octets).readonly requireConnectProtocolHeader: boolean— Exige l’en-têteConnect-Protocol-Versionsur les requêtes Connect.