Interface Connection

A Connection is a high-level representation of a connection to a remote peer that may have been secured by encryption and multiplexed, depending on the configuration of the nodes between which the connection is made.

Hierarchy

Connection

Index

Properties

addStream close id newStream remoteAddr remotePeer removeStream stat streams tags

Properties

addStream

addStream: ((stream: Stream) => void)

Type declaration

- (stream: Stream): void
- Parameters
  - stream: Stream
  Returns void

close

close: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

id

id: string

newStream

newStream: ((multicodecs: string | string[], options?: NewStreamOptions) => Promise<Stream>)

Type declaration

- (multicodecs: string | string[], options?: NewStreamOptions): Promise<Stream>
- Parameters
  - multicodecs: string | string[]
  - Optional options: NewStreamOptions
  Returns Promise<Stream>

remoteAddr

remoteAddr: Multiaddr

remotePeer

remotePeer: PeerId

removeStream

removeStream: ((id: string) => void)

Type declaration

- (id: string): void
- Parameters
  - id: string
  Returns void

stat

stat: ConnectionStat

streams

streams: Stream[]

tags

tags: string[]