Interface Transport

Transport abstraction for Raft RPC exchange.

interface Transport {
    addPeer?(peerId: string, address: string): Promise<void>;
    isStarted(): boolean;
    onMessage(handler: MessageHandler): void;
    removePeer?(peerId: string): void;
    send(peerId: string, message: RPCMessage): Promise<RPCMessage>;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Implemented by

GrpcTransport

Index

Methods

addPeer? isStarted onMessage removePeer? send start stop

Methods

`Optional`addPeer

addPeer?(peerId: string, address: string): Promise<void>
Optionally registers a peer endpoint at runtime.
Parameters
- peerId: string
- address: string
Returns Promise<void>
- Defined in packages/raft-core/src/transport/Transport.ts:27

isStarted

isStarted(): boolean
Returns true when transport is currently started.

Returns boolean
- Defined in packages/raft-core/src/transport/Transport.ts:21

onMessage

onMessage(handler: MessageHandler): void
Registers inbound request handler.
Parameters
- handler: MessageHandler
Returns void
- Defined in packages/raft-core/src/transport/Transport.ts:25

`Optional`removePeer

removePeer?(peerId: string): void
Optionally removes a peer endpoint at runtime.
Parameters
- peerId: string
Returns void
- Defined in packages/raft-core/src/transport/Transport.ts:29

send

send(peerId: string, message: RPCMessage): Promise<RPCMessage>
Sends one RPC message to a peer and returns response message.
Parameters
- peerId: string
- message: RPCMessage
Returns Promise<RPCMessage>
- Defined in packages/raft-core/src/transport/Transport.ts:23

start

start(): Promise<void>
Starts the transport listener/client resources.

Returns Promise<void>
- Defined in packages/raft-core/src/transport/Transport.ts:17

stop

stop(): Promise<void>
Stops the transport and releases resources.

Returns Promise<void>
- Defined in packages/raft-core/src/transport/Transport.ts:19