Interface Registrar

interface Registrar {
    getHandler(protocol): StreamHandlerRecord;
    getProtocols(): string[];
    getTopologies(protocol): Topology[];
    handle(protocol, handler, options?): Promise<void>;
    register(protocol, topology): Promise<string>;
    unhandle(protocol): Promise<void>;
    unregister(id): void;
}

Index

Methods

getHandler getProtocols getTopologies handle register unhandle unregister

Methods

getHandler

getHandler(protocol): StreamHandlerRecord
Return the handler for the passed protocol
Parameters
- protocol: string
Returns StreamHandlerRecord
- Defined in packages/interface-internal/src/registrar/index.ts:75

getProtocols

getProtocols(): string[]
Return the list of protocols with registered handlers

Returns string[]
- Defined in packages/interface-internal/src/registrar/index.ts:60

getTopologies

getTopologies(protocol): Topology[]
Return all topology handlers that wish to be informed about peers that support the passed protocol.
Parameters
- protocol: string
Returns Topology[]
- Defined in packages/interface-internal/src/registrar/index.ts:96

handle

handle(protocol, handler, options?): Promise<void>
Add a protocol handler
Parameters
- protocol: string
- handler: StreamHandler
- Optional options: StreamHandlerOptions
Returns Promise<void>
- Defined in packages/interface-internal/src/registrar/index.ts:65

register

register(protocol, topology): 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
- topology: Topology
Returns Promise<string>
- Defined in packages/interface-internal/src/registrar/index.ts:85

unhandle

unhandle(protocol): Promise<void>
Remove a protocol handler
Parameters
- protocol: string
Returns Promise<void>
- Defined in packages/interface-internal/src/registrar/index.ts:70

unregister

unregister(id): void
Remove the topology handler with the passed id.
Parameters
- id: string
Returns void
- Defined in packages/interface-internal/src/registrar/index.ts:90