Interface NetworkNodeStub

Deprecated

This in an internal interface

Hierarchy

  • NetworkNodeStub

Properties

addMessageListener getMetricsContext getNeighbors getNeighborsForStreamPart getNodeId getRtt getStreamParts hasStreamPart publish removeMessageListener setExtraMetadata subscribe subscribeAndWaitForJoin unsubscribe waitForJoinAndPublish

Properties

addMessageListener

addMessageListener: ((listener: ((msg: StreamMessage<unknown>) => void)) => void)

Type declaration

getMetricsContext

getMetricsContext: (() => MetricsContext)

Type declaration

getNeighbors

getNeighbors: (() => readonly string[])

Type declaration

    • (): readonly string[]

    • Returns readonly string[]

getNeighborsForStreamPart

getNeighborsForStreamPart: ((streamPartId: StreamPartID) => readonly string[])

Type declaration

getNodeId

getNodeId: (() => string)

Type declaration

    • (): string

    • Returns string

getRtt

getRtt: ((nodeId: string) => undefined | number)

Type declaration

    • (nodeId: string): undefined | number

    • Parameters

      • nodeId: string

      Returns undefined | number

getStreamParts

getStreamParts: (() => Iterable<StreamPartID>)

Type declaration

hasStreamPart

hasStreamPart: ((streamPartId: StreamPartID) => boolean)

Type declaration

publish

publish: ((streamMessage: StreamMessage<unknown>) => void)

Type declaration

removeMessageListener

removeMessageListener: ((listener: ((msg: StreamMessage<unknown>) => void)) => void)

Type declaration

setExtraMetadata

setExtraMetadata: ((metadata: Record<string, unknown>) => void)

Type declaration

    • (metadata: Record<string, unknown>): void

    • Parameters

      • metadata: Record<string, unknown>

      Returns void

subscribe

subscribe: ((streamPartId: StreamPartID) => void)

Type declaration

subscribeAndWaitForJoin

subscribeAndWaitForJoin: ((streamPart: StreamPartID, timeout?: number) => Promise<number>)

Type declaration

    • (streamPart: StreamPartID, timeout?: number): Promise<number>

    • Parameters

      Returns Promise<number>

unsubscribe

unsubscribe: ((streamPartId: StreamPartID) => void)

Type declaration

waitForJoinAndPublish

waitForJoinAndPublish: ((msg: StreamMessage<unknown>, timeout?: number) => Promise<number>)

Type declaration

    • (msg: StreamMessage<unknown>, timeout?: number): Promise<number>

    • Parameters

      Returns Promise<number>

Settings

Member Visibility

Theme

Generated using TypeDoc