Interface Registrar

The Registrar provides an interface for registering protocol handlers - these are invoked when remote peers open streams on the local node with the corresponding protocol name.

It also allows configuring network topologies for a given protocol(s). The topology callbacks are invoked when a peer that supports those protocols connects or disconnects.

The Identify protocol must be configured on the current node for topologies to function.

interface Registrar {
    getHandler(protocol: string): StreamHandlerRecord;
    getMiddleware(protocol: string): StreamMiddleware[];
    getProtocols(): string[];
    getTopologies(protocol: string): Topology[];
    handle(
        protocol: string,
        handler: StreamHandler,
        options?: StreamHandlerOptions,
    ): Promise<void>;
    register(
        protocol: string,
        topology: Topology,
        options?: AbortOptions,
    ): Promise<string>;
    unhandle(protocol: string, options?: AbortOptions): Promise<void>;
    unregister(id: string): void;
    unuse(middleware: StreamMiddleware): void;
    unuse(protocol: string): void;
    use(middleware: StreamMiddleware): void;
    use(protocol: string, middleware: StreamMiddleware[]): void;
}

Index

Methods

getHandler getMiddleware getProtocols getTopologies handle register unhandle unregister unuse use

Methods

getHandler

getHandler(protocol: string): StreamHandlerRecord
Retrieve the registered handler for a given protocol.
Parameters
- protocol: string
  The protocol to query.
Returns StreamHandlerRecord
A StreamHandlerRecord containing the handler and options.
- Defined in packages/interface-internal/src/registrar.ts:47

getMiddleware

getMiddleware(protocol: string): StreamMiddleware[]
Return a fresh chain with global middleware before protocol-specific middleware. Mutating the result does not change registered middleware.
Parameters
- protocol: string
Returns StreamMiddleware[]
- Defined in packages/interface-internal/src/registrar.ts:74

getProtocols

getProtocols(): string[]
Retrieve the list of registered protocol handlers.

Returns string[]
An array of protocol strings.
- Defined in packages/interface-internal/src/registrar.ts:21

getTopologies

getTopologies(protocol: string): Topology[]
Retrieve all topology handlers that are interested in peers supporting a given protocol.
Parameters
- protocol: string
  The protocol to query.
Returns Topology[]
An array of registered Topology handlers.
- Defined in packages/interface-internal/src/registrar.ts:104

handle

handle(
    protocol: string,
    handler: StreamHandler,
    options?: StreamHandlerOptions,
): Promise<void>
Register a handler for a specific protocol.
Parameters
- protocol: string
  The protocol string (e.g., /my-protocol/1.0.0).
- handler: StreamHandler
  The function that handles incoming streams.
- Optionaloptions: StreamHandlerOptions
  Optional configuration options for the handler.
Returns Promise<void>
A promise that resolves once the handler is registered.
- Defined in packages/interface-internal/src/registrar.ts:31

register

register(
    protocol: string,
    topology: Topology,
    options?: AbortOptions,
): Promise<string>
Register a topology handler for a protocol - the topology will be invoked when peers are discovered on the network that support the passed protocol.

An id will be returned that can later be used to unregister the topology.
Parameters
- protocol: string
  The protocol to register.
- topology: Topology
  The topology handler to register.
- Optionaloptions: AbortOptions
Returns Promise<string>
A promise resolving to a unique ID for the registered topology.
- Defined in packages/interface-internal/src/registrar.ts:88

unhandle

unhandle(protocol: string, options?: AbortOptions): Promise<void>
Remove a registered protocol handler.
Parameters
- protocol: string
  The protocol to unhandle.
- Optionaloptions: AbortOptions
Returns Promise<void>
A promise that resolves once the handler is removed.
- Defined in packages/interface-internal/src/registrar.ts:39

unregister

unregister(id: string): void
Unregister a topology handler using its unique ID.
Parameters
- id: string
  The ID of the topology to unregister.
Returns void
- Defined in packages/interface-internal/src/registrar.ts:95

unuse

unuse(middleware: StreamMiddleware): void
Remove all global registrations of the given middleware.
Parameters
- middleware: StreamMiddleware
Returns void
- Defined in packages/interface-internal/src/registrar.ts:63
unuse(protocol: string): void
Remove the middleware registered for a protocol.
Parameters
- protocol: string
Returns void
- Defined in packages/interface-internal/src/registrar.ts:68

use

use(middleware: StreamMiddleware): void
Append global middleware, invoked before protocol-specific middleware. This does not register a handler or advertise protocol support.
Parameters
- middleware: StreamMiddleware
Returns void
- Defined in packages/interface-internal/src/registrar.ts:53
use(protocol: string, middleware: StreamMiddleware[]): void
Replace the middleware registered for a protocol.
Parameters
- protocol: string
- middleware: StreamMiddleware[]
Returns void
- Defined in packages/interface-internal/src/registrar.ts:58

Interface Registrar

Index

Methods

Methods

getHandler

Parameters

Returns StreamHandlerRecord

getMiddleware

Parameters

Returns StreamMiddleware[]

getProtocols

Returns string[]

getTopologies

Parameters

Returns Topology[]

handle

Parameters

Returns Promise<void>

register

Parameters

Returns Promise<string>

unhandle

Parameters

Returns Promise<void>

unregister

Parameters

Returns void

unuse

Parameters

Returns void

Parameters

Returns void

use

Parameters

Returns void

Parameters

Returns void

Settings

On This Page