Interface IdentifyPushInit

interface IdentifyPushInit {
    agentVersion?: string;
    concurrency?: number;
    maxInboundStreams?: number;
    maxMessageSize?: number;
    maxObservedAddresses?: number;
    maxOutboundStreams?: number;
    protocolPrefix?: string;
    runOnLimitedConnection?: boolean;
    runOnSelfUpdate?: boolean;
    timeout?: number;
}

Hierarchy

Properties

agentVersion? concurrency? maxInboundStreams? maxMessageSize? maxObservedAddresses? maxOutboundStreams? protocolPrefix? runOnLimitedConnection? runOnSelfUpdate? timeout?

Properties

Optional agentVersion

agentVersion?: string

What details we should send as part of an identify message

Optional concurrency

concurrency?: number

Push to this many connections in parallel

Default

32

Optional maxInboundStreams

maxInboundStreams?: number

The maximum number of inbound streams that may be open on a single connection for this protocol

Default

1

Optional maxMessageSize

maxMessageSize?: number

Identify responses larger than this in bytes will be rejected

Default

8192

Optional maxObservedAddresses

maxObservedAddresses?: number

The maximum number of observed addresses to send in an Identify message

Optional maxOutboundStreams

maxOutboundStreams?: number

The maximum number of outbound streams that may be open on a single connection for this protocol

Default

1

Optional protocolPrefix

protocolPrefix?: string

The prefix to use for the protocol

Default

'ipfs'

Optional runOnLimitedConnection

runOnLimitedConnection?: boolean

Whether to run on connections with data or duration limits

Default

true

Optional runOnSelfUpdate

runOnSelfUpdate?: boolean

Whether to automatically dial identify-push on self updates

Default

true

Optional timeout

timeout?: number

How long we should wait for a remote peer to send their identify response

Default

5000

Settings

Member Visibility

Theme

On This Page

agentVersionconcurrencymaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnLimitedConnectionrunOnSelfUpdatetimeout