Interface MultiaddrConnection

A MultiaddrConnection is returned by transports after dialing a peer. It is a low-level primitive and is the raw connection without encryption or stream multiplexing.

interface MultiaddrConnection {
    log: Logger;
    remoteAddr: Multiaddr;
    sink: Sink<
        AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
        unknown,
    >;
    source: AsyncGenerator;
    timeline: MultiaddrConnectionTimeline;
    abort(err: Error): void;
    close(options?: AbortOptions): Promise<void>;
}

Hierarchy

Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>>
- MultiaddrConnection

Index

Properties

log remoteAddr sink source timeline

Methods

Properties

log

The multiaddr connection logger

remoteAddr

remoteAddr: Multiaddr

The address of the remote end of the connection

sink

sink: Sink<
AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
unknown,
>

source

source: AsyncGenerator

timeline

timeline: MultiaddrConnectionTimeline

When connection life cycle events occurred

Methods

abort

abort(err: Error): void
Immediately close the connection, any queued data will be discarded
Parameters
- err: Error
Returns void
- Defined in packages/interface/src/connection.ts:393

close

close(options?: AbortOptions): Promise<void>
Gracefully close the connection. All queued data will be written to the underlying transport.
Parameters
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in packages/interface/src/connection.ts:388