Interface Registrar

Hierarchy

Registrar

Index

Properties

getHandler getProtocols getTopologies handle register unhandle unregister

Properties

getHandler

getHandler: ((protocol: string) => StreamHandlerRecord)

Type declaration

- (protocol: string): StreamHandlerRecord
- Return the handler for the passed protocol
  Parameters
  - protocol: string
  Returns StreamHandlerRecord

getProtocols

getProtocols: (() => string[])

Type declaration

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

getTopologies

getTopologies: ((protocol: string) => Topology[])

Type declaration

- (protocol: string): Topology[]
- Return all topology handlers that wish to be informed about peers that support the passed protocol.
  Parameters
  - protocol: string
  Returns Topology[]

handle

handle: ((protocol: string, handler: StreamHandler, options?: StreamHandlerOptions) => Promise<void>)

Type declaration

- (protocol: string, handler: StreamHandler, options?: StreamHandlerOptions): Promise<void>
- Add a protocol handler
  Parameters
  - protocol: string
  - handler: StreamHandler
  - Optional options: StreamHandlerOptions
  Returns Promise<void>

register

register: ((protocol: string, topology: Topology) => Promise<string>)

Type declaration

- (protocol: string, topology: 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>

unhandle

unhandle: ((protocol: string) => Promise<void>)

Type declaration

- (protocol: string): Promise<void>
- Remove a protocol handler
  Parameters
  - protocol: string
  Returns Promise<void>

unregister

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

Type declaration

- (id: string): void
- Remove the topology handler with the passed id.
  Parameters
  - id: string
  Returns void