Class PeerStreams

Thin wrapper around a peer's inbound / outbound pubsub streams

Hierarchy

Index

References

Constructors

Properties

Accessors

Methods

References

Events

Re-exports Events

MuxedStream

Re-exports MuxedStream

PeerId

Re-exports PeerId

PushableStream

Re-exports PushableStream

Constructors

constructor

Properties

Private _inboundAbortController

_inboundAbortController: any

An AbortController for controlled shutdown of the inbound stream

Private _rawInboundStream

_rawInboundStream: any

The raw inbound stream, as retrieved from the callback from libp2p.handle

Private _rawOutboundStream

_rawOutboundStream: any

The raw outbound stream, as retrieved from conn.newStream

id

id: PeerId

inboundStream

inboundStream: null | AsyncIterable<Uint8Array>

Read stream

outboundStream

outboundStream: null | Pushable<Uint8Array>

Write stream -- its preferable to use the write method

protocol

protocol: string

Established protocol

Accessors

isReadable

  • get isReadable(): boolean

  • Do we have a connection to read from?

    Returns boolean

isWritable

  • get isWritable(): boolean

  • Do we have a connection to write on?

    Returns boolean

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

attachInboundStream

  • attachInboundStream(stream: MuxedStream): AsyncIterable<Uint8Array>

  • Attach a raw inbound stream and setup a read stream

    Parameters

    Returns AsyncIterable<Uint8Array>

attachOutboundStream

  • attachOutboundStream(stream: MuxedStream): Promise<void>

  • Attach a raw outbound stream and setup a write stream

    Parameters

    Returns Promise<void>

close

  • close(): void

  • Closes the open connection to peer

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

on

  • on(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

once

  • once(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): any

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

setMaxListeners

  • setMaxListeners(n: number): any

write

  • write(data: Uint8Array): void

  • Send a message to this peer. Throws if there is no stream to write to available.

    Parameters

    • data: Uint8Array

    Returns void