Class GrpcTransport

gRPC transport implementation for raft-core Transport interface.

Remarks

Handles client/server lifecycle, request/response conversion between protobuf payloads and raft-core RPC messages, peer management, and timeout/deadline wiring.

Implements

Transport

Index

Constructors

constructor

Methods

addPeer isStarted onMessage removePeer send start stop

Constructors

constructor

new GrpcTransport(
    nodeId: string,
    port: number,
    peers: Record<NodeId, string>,
    certPaths?: { caCert: string; nodeCert: string; nodeKey: string },
    callTimeoutMs?: number,
    shutdownTimeoutMs?: number,
    maxGrpcMessageBytes?: number,
): GrpcTransport
Parameters
- nodeId: string
- port: number
- peers: Record<NodeId, string>
- OptionalcertPaths: { caCert: string; nodeCert: string; nodeKey: string }
- callTimeoutMs: number = 5000
- shutdownTimeoutMs: number = 5000
- maxGrpcMessageBytes: number = ...
Returns GrpcTransport
- Defined in GRPCTransport.ts:229

Methods

addPeer

addPeer(peerId: string, address: string): Promise<void>
Adds or replaces a gRPC client for a peer.
Parameters
- peerId: string
  Peer node id.
- address: string
  Peer gRPC endpoint address.
Returns Promise<void>
Throws
NetworkError When transport is not initialized.
Implementation of Transport.addPeer
- Defined in GRPCTransport.ts:405

isStarted

isStarted(): boolean
Returns true when transport has been started and not yet stopped.

Returns boolean
Implementation of Transport.isStarted
- Defined in GRPCTransport.ts:353

onMessage

onMessage(handler: MessageHandler): void
Registers the inbound message handler used by gRPC service methods.
Parameters
- handler: MessageHandler
Returns void
Implementation of Transport.onMessage
- Defined in GRPCTransport.ts:394

removePeer

removePeer(peerId: string): void
Removes and closes an existing peer client when present.
Parameters
- peerId: string
  Peer node id.
Returns void
Implementation of Transport.removePeer
- Defined in GRPCTransport.ts:432

send

send(peerId: string, message: RPCMessage): Promise<RPCMessage>
Sends one request RPC to a peer and resolves with mapped raft-core response.
Parameters
- peerId: string
  Target peer node id.
- message: RPCMessage
  Outbound raft-core request envelope.
Returns Promise<RPCMessage>
Response envelope converted from gRPC payload.

Throws
NetworkError When transport/peer is unavailable or RPC call fails.
Implementation of Transport.send
- Defined in GRPCTransport.ts:365

start

start(): Promise<void>
Starts gRPC server, loads TLS credentials when configured, and initializes peer clients.

Returns Promise<void>
Throws
NetworkError When transport is already started or bind fails.
Implementation of Transport.start
- Defined in GRPCTransport.ts:252

stop

stop(): Promise<void>
Stops server and closes all clients with graceful shutdown fallback.

Returns Promise<void>
Throws
NetworkError When transport is not started.
Implementation of Transport.stop
- Defined in GRPCTransport.ts:323

Class GrpcTransport

Remarks

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GrpcTransport

Methods

addPeer

Parameters

Returns Promise<void>

Throws

isStarted

Returns boolean

onMessage

Parameters

Returns void

removePeer

Parameters

Returns void

send

Parameters

Returns Promise<RPCMessage>

Throws

start

Returns Promise<void>

Throws

stop

Returns Promise<void>

Throws

Settings

On This Page