Optional init: FloodSubInitPrivate #privateIf router can relay received messages, even if not subscribed
-if publish should emit to self, if subscribed
-Protected enabledThe signature policy to follow by default
-Protected logA list of multicodecs that contain the pubsub protocol name.
-Map of peer streams
-List of our subscriptions
-Topic validator map
+Optional init: FloodSubInitPrivate #privateIf router can relay received messages, even if not subscribed
+if publish should emit to self, if subscribed
+Protected enabledThe signature policy to follow by default
+Protected logA list of multicodecs that contain the pubsub protocol name.
+Map of peer streams
+List of our subscriptions
+Topic validator map
Keyed by topic Topic validators are functions with the following input:
-Map of topics to which peers are subscribed to
-Protected _onOn an inbound stream opened
-Protected _onRegistrar notifies an established connection with pubsub protocol
-Protected _onRegistrar notifies a closing connection with pubsub protocol
-Optional conn: ConnectionProtected _removeNotifies the router that a peer has been disconnected
-Map of topics to which peers are subscribed to
+Protected _onOn an inbound stream opened
+Protected _onRegistrar notifies an established connection with pubsub protocol
+Protected _onRegistrar notifies a closing connection with pubsub protocol
+Optional conn: ConnectionProtected _removeNotifies the router that a peer has been disconnected
+Whether to accept a message from a peer Override to create a graylist
-Optional options: boolean | AddEventListenerOptionsNotifies the router that a peer has been connected
-Optional options: boolean | AddEventListenerOptionsNotifies the router that a peer has been connected
+Normalizes the message and signs it, if signing is enabled. Should be used by the routers to create the message to send.
-Decode a Uint8Array into an RPC object
-Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
+Decode a Uint8Array into an RPC object
+Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Encode RPC object into a Uint8Array. This can be override to use a custom router protobuf.
-Encode an RPC object into a Uint8Array
-The default msgID implementation +
Encode an RPC object into a Uint8Array
+The default msgID implementation Child class can override this.
-Process incoming message +
Responsible for processing each RPC message received by other peers.
-Handles an rpc request from a peer
-Handles a subscription change from a peer
-Publishes messages to all subscribed peers
-Optional data: Uint8ArrayPublish message created. Forward it to the peers.
-Optional listener: null | EventHandler<PubSubEvents[K]>Optional options: boolean | EventListenerOptionsResponsible for processing each RPC message received by other peers.
+Handles an rpc request from a peer
+Handles a subscription change from a peer
+Publishes messages to all subscribed peers
+Optional data: Uint8ArrayPublish message created. Forward it to the peers.
+Optional listener: null | EventHandler<PubSubEvents[K]>Optional options: boolean | EventListenerOptionsGenerated using TypeDoc
Generated using TypeDoc
FloodSub (aka dumbsub is an implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).
-