Class RPCChannel<LocalAPI, RemoteAPI>

Owns one RPC transport, exposes an optional local API, and creates a typed remote proxy.

Type Parameters

LocalAPI extends object = object
RemoteAPI extends object = object

Constructors

constructor

new RPCChannel<
    LocalAPI extends object = object,
    RemoteAPI extends object = object,
>(
    transport: Transport<RPCMessage>,
    options?: RPCChannelOptions<LocalAPI>,
): RPCChannel<LocalAPI, RemoteAPI>
Create a channel over one transport.

The constructor subscribes immediately so incoming messages can be handled as soon as the transport starts delivering them.
Type Parameters
- LocalAPI extends object = object
- RemoteAPI extends object = object
Parameters
- transport: Transport<RPCMessage>
- options: RPCChannelOptions<LocalAPI> = {}
Returns RPCChannel<LocalAPI, RemoteAPI>
- Defined in packages/kkrpc/src/core/channel.ts:332

Properties

`Protected`closed

closed: boolean = false

`Protected` `Optional`closeReason

closeReason?: Error

`Protected`destroyed

destroyed: boolean = false

`Protected` `Optional`expose

expose?: LocalAPI

`Protected` `Optional`getMetadata

getMetadata?: () => undefined | RPCMessageMetadata

`Protected`pending

pending: Map<string, PendingRequest> = ...

`Protected`plugins

plugins: readonly RPCPlugin[]

`Protected`supportsTransfer

supportsTransfer: boolean

`Protected`timeout

timeout: number

`Protected`transport

transport: Transport<RPCMessage>

Methods

`Protected`armPending

armPending(
    id: string,
    pending: PendingRequest,
    reject: (error: Error) => void,
    callOptions?: CallOptions,
): void
Store a pending request and arm its timeout and abort-signal handlers.
Parameters
- id: string
- pending: PendingRequest
- reject: (error: Error) => void
- OptionalcallOptions: CallOptions
Returns void
- Defined in packages/kkrpc/src/core/channel.ts:486

`Protected`createCallbackFacade

createCallbackFacade(id: string): (...args: unknown[]) => void
Build a local function that forwards calls to a remote callback by id.
Parameters
- id: string
Returns (...args: unknown[]) => void
- Defined in packages/kkrpc/src/core/channel.ts:734

`Protected`createProxy

createProxy(path: string[], callOptions?: CallOptions): unknown
Create a remote proxy rooted at a protocol path, optionally with per-call options.
Parameters
- path: string[]
- OptionalcallOptions: CallOptions
Returns unknown
- Defined in packages/kkrpc/src/core/channel.ts:408

`Protected`decodeArgs

decodeArgs(args: unknown[]): unknown[]
Decode value and callback envelopes into local call arguments.
Parameters
- args: unknown[]
Returns unknown[]
- Defined in packages/kkrpc/src/core/channel.ts:722

`Protected`decodeValue

decodeValue(value: unknown): unknown
Decode one value. Subclasses may override for opt-in feature envelopes.
Parameters
- value: unknown
Returns unknown
- Defined in packages/kkrpc/src/core/channel.ts:792

destroy

destroy(): void
Close the transport subscription, reject pending calls, and release callback records.

Returns void
- Defined in packages/kkrpc/src/core/channel.ts:390

`Protected`encodeArgs

encodeArgs(args: unknown[], transfers: Transferable[]): unknown[]
Encode call arguments into value and callback envelopes.
Parameters
- args: unknown[]
- transfers: Transferable[]
Returns unknown[]
- Defined in packages/kkrpc/src/core/channel.ts:698

`Protected`encodeValue

encodeValue(value: unknown, transfers: Transferable[]): unknown
Encode a value and collect transferables when the transport supports them.
Parameters
- value: unknown
- transfers: Transferable[]
Returns unknown
- Defined in packages/kkrpc/src/core/channel.ts:784

`Protected`executeRequest

executeRequest(message: RPCRequest): Promise<unknown>
Run plugin hooks and invoke the local API for one incoming request.
Parameters
- message: RPCRequest
Returns Promise<unknown>
- Defined in packages/kkrpc/src/core/channel.ts:625

getAPI

getAPI(): RemoteAPI
Return a typed proxy that sends operations to the remote API.

Returns RemoteAPI
- Defined in packages/kkrpc/src/core/channel.ts:385

`Protected`handleMessage

handleMessage(message: RPCMessage): Promise<void>
Dispatch one incoming protocol message by message kind.
Parameters
- message: RPCMessage
Returns Promise<void>
- Defined in packages/kkrpc/src/core/channel.ts:558

`Protected`handleRequest

handleRequest(message: RPCRequest): Promise<void>
Execute an incoming request and post a protocol response.
Parameters
- message: RPCRequest
Returns Promise<void>
- Defined in packages/kkrpc/src/core/channel.ts:612

`Protected`handleResponse

handleResponse(id: string, value: unknown, error?: RPCError): void
Resolve or reject the pending request associated with a response.
Parameters
- id: string
- value: unknown
- Optionalerror: RPCError
Returns void
- Defined in packages/kkrpc/src/core/channel.ts:598

`Protected`handleTransportClose

handleTransportClose(reason?: Error): void
Reject all pending requests when the transport connection closes.

Subsequent requests fail fast with RPCTransportClosedError. The channel is not destroyed: the exposed API, plugins, and callback registry stay intact so the instance can still be inspected. Reconnect by creating a new transport and channel. Overridden by StreamingRPCChannel to also fail stream state.
Parameters
- Optionalreason: Error
Returns void
- Defined in packages/kkrpc/src/core/channel.ts:366

`Protected`handleWriteFailure

handleWriteFailure(
    pendingId: undefined | string,
    error: unknown,
    onWriteError?: (error: Error) => void,
): void
Dispatch transport write failures to request waiters.
Parameters
- pendingId: undefined | string
- error: unknown
- OptionalonWriteError: (error: Error) => void
Returns void
- Defined in packages/kkrpc/src/core/channel.ts:536

`Protected`invokeRequest

invokeRequest(
    ctx: {
        args: unknown[];
        operation: RPCOperation;
        path: string[];
        value?: unknown;
    },
): Promise<unknown>
Invoke the exposed local API according to one compact RPC operation.
Parameters
- ctx: { args: unknown[]; operation: RPCOperation; path: string[]; value?: unknown }
Returns Promise<unknown>
- Defined in packages/kkrpc/src/core/channel.ts:671

`Protected`post

post(
    message: RPCMessage,
    transfers?: Transferable[],
    pendingId?: string,
    onWriteError?: (error: Error) => void,
): void | Promise<void>
Send one protocol message and reject the pending request on write failure.
Parameters
- message: RPCMessage
- transfers: Transferable[] = []
- OptionalpendingId: string
- OptionalonWriteError: (error: Error) => void
Returns void | Promise<void>
- Defined in packages/kkrpc/src/core/channel.ts:519

`Protected`rejectPendingWrite

rejectPendingWrite(pendingId: undefined | string, error: unknown): void
Reject a pending request when its transport write fails.
Parameters
- pendingId: undefined | string
- error: unknown
Returns void
- Defined in packages/kkrpc/src/core/channel.ts:547

`Protected`reportUncaughtError

reportUncaughtError(
error: unknown,
context: { kind: "set" | "callback"; path?: string[] },
): void
Report an error from a fire-and-forget path to the optional diagnostics hook.
Parameters
- error: unknown
- context: { kind: "set" | "callback"; path?: string[] }
Returns void
- Defined in packages/kkrpc/src/core/channel.ts:472

`Protected`request

request(
    op: RPCOperation,
    path: string[],
    args?: unknown[],
    value?: unknown,
    callOptions?: CallOptions,
): Promise<unknown>
Send one RPC request and return the pending response promise.
Parameters
- op: RPCOperation
- path: string[]
- Optionalargs: unknown[]
- value: unknown = NO_VALUE
- OptionalcallOptions: CallOptions
Returns Promise<unknown>
- Defined in packages/kkrpc/src/core/channel.ts:440

Class RPCChannel<LocalAPI, RemoteAPI>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RPCChannel<LocalAPI, RemoteAPI>

Properties

Protectedclosed

Protected OptionalcloseReason

Protecteddestroyed

Protected Optionalexpose

Protected OptionalgetMetadata

Protectedpending

Protectedplugins

ProtectedsupportsTransfer

Protectedtimeout

Protectedtransport

Methods

ProtectedarmPending

Parameters

Returns void

ProtectedcreateCallbackFacade

Parameters

Returns (...args: unknown[]) => void

ProtectedcreateProxy

Parameters

Returns unknown

ProtecteddecodeArgs

Parameters

Returns unknown[]

ProtecteddecodeValue

Parameters

Returns unknown

destroy

Returns void

ProtectedencodeArgs

Parameters

Returns unknown[]

ProtectedencodeValue

Parameters

Returns unknown

ProtectedexecuteRequest

Parameters

Returns Promise<unknown>

getAPI

Returns RemoteAPI

ProtectedhandleMessage

Parameters

Returns Promise<void>

ProtectedhandleRequest

Parameters

Returns Promise<void>

ProtectedhandleResponse

Parameters

Returns void

ProtectedhandleTransportClose

Parameters

Returns void

ProtectedhandleWriteFailure

Parameters

Returns void

ProtectedinvokeRequest

Parameters

Returns Promise<unknown>

Protectedpost

Parameters

Returns void | Promise<void>

ProtectedrejectPendingWrite

Parameters

Returns void

ProtectedreportUncaughtError

Parameters

Returns void

Protectedrequest

Parameters

`Protected`closed

`Protected` `Optional`closeReason

`Protected`destroyed

`Protected` `Optional`expose

`Protected` `Optional`getMetadata

`Protected`pending

`Protected`plugins

`Protected`supportsTransfer

`Protected`timeout

`Protected`transport

`Protected`armPending

`Protected`createCallbackFacade

`Protected`createProxy

`Protected`decodeArgs

`Protected`decodeValue

`Protected`encodeArgs

`Protected`encodeValue

`Protected`executeRequest

`Protected`handleMessage

`Protected`handleRequest

`Protected`handleResponse

`Protected`handleTransportClose

`Protected`handleWriteFailure

`Protected`invokeRequest

`Protected`post

`Protected`rejectPendingWrite

`Protected`reportUncaughtError

`Protected`request