Interface RelayNode

interface RelayNode {
    connectionManager: IConnectionManager;
    filter: undefined;
    libp2p: Libp2p;
    lightPush: undefined;
    relay: IRelay;
    store: undefined;
    dial(peer, protocols?): Promise<Stream>;
    isConnected(): boolean;
    isStarted(): boolean;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Hierarchy (view full)

Properties

connectionManager filter libp2p lightPush relay store

Methods

dial isConnected isStarted start stop

Properties

connectionManager

connectionManager: IConnectionManager

filter

filter: undefined

libp2p

libp2p: Libp2p

lightPush

lightPush: undefined

relay

relay: IRelay

store

store: undefined

Methods

dial

  • dial(peer, protocols?): Promise<Stream>

  • Parameters

    • peer: PeerId | MultiaddrInput
    • Optional protocols: Protocols[]

    Returns Promise<Stream>

isConnected

  • isConnected(): boolean

  • Returns boolean

isStarted

  • isStarted(): boolean

  • Returns boolean

start

  • start(): Promise<void>

  • Returns Promise<void>

stop

  • stop(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

connectionManagerfilterlibp2plightPushrelaystoredialisConnectedisStartedstartstop

Generated using TypeDoc