Class SyncpsPubsub

constructor

• new SyncpsPubsub(__namedParameters): SyncpsPubsub

• Parameters

  • __namedParameters: SyncpsPubsub.Options

  Returns SyncpsPubsub

Readonly describe

close

• close(): void

• Stop the protocol operation.

  Returns void

publish

• publish(pub, cb?): Promise<void>

• Publish a packet.

  Parameters

  • pub: Data

    Data packet. This does not need to be signed.
  • Optional cb: SyncpsPubsub.PublishCallback

    Callback to get notified whether publication is confirmed, i.e. its hash appears in a sync Interest from another participant.

  Returns Promise<void>

  • Promise that resolves when the publication is recorded. It does not mean the publication has reached other participants.

subscribe

• subscribe(topic): Subscription<Name, CustomEvent<Data>>

• Subscribe to a topic.

  Parameters

  • topic: Name

  Returns Subscription<Name, CustomEvent<Data>>