Categorygithub.com/bdware/go-libp2p-collect
modulepackage
0.0.12
Repository: https://github.com/bdware/go-libp2p-collect.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
23
Dependents
0
Files
2.5k SLOC

# README

go-libp2p-collect

Discourse posts Build Status

A pub-sub-collect system.

This is the a pub-sub-collect implementation for libp2p.

We currently provide following implementations:

  • floodcollect, which is based on floodpub——the baseline flooding protocol.

Table of Contents

Install

go get github.com/bdware/go-libp2p-collect

Usage

To be used for messaging and data collection in p2p instrastructure (as part of libp2p) such as BDWare, IPFS, Ethereum, other blockchains, etc.

Documentation

See API documentation.

Contribute

Contributions welcome. Please check out the issues.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT

Copyright (c) 2020 The BDWare Authors. All rights reserved.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

DefaultMsgIDFn should be used with DefaultMsgIDFn.
DefaultReqIDFn returns default ReqIDGenerator.
MakeDefaultConf returns a default Conf instance.
MakeDefaultIntBFSOptions .
MakeDefaultLogger .
NewAsyncPubSub returns a new Topics instance.
NewBasicPubSubCollector returns a new BasicPubSubCollector.
NewCollector creates PubSubCollector.
No description provided by the author
NewInitOpts returns initopts.
No description provided by the author
No description provided by the author
NewJoinOptions returns an option collection.
No description provided by the author
NewPublishOptions returns an option collection.
NewRelayPubSubCollector .
No description provided by the author
WithConf specifies configuration of pubsubcollector.
WithCustomPubSubFactory initials the pubsub based on given factory.
WithFinalRespHandler registers notifHandler.
WithLogger .
No description provided by the author
WithRequestContext adds cancellation or timeout for a request default is withCancel.
WithRequestHandler registers request handler.
WithRequestIDGenerator .
WithSelfNotif decides whether a node receives self-published messages.

# Constants

No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

AsyncPubSub encapsulates pubsub, provides async methods to get subscribe messages.
BasicPubSubCollector implements of psc.BasicPubSubCollector Interface.
Conf is the static configuration of PubSubCollector.
No description provided by the author
InitOpts is options used in NewBasicPubSubCollector.
IntBFS don't care about topic.
IntBFSCollector .
IntBFSOptions .
JoinOpts is the aggregated options.
No description provided by the author
No description provided by the author
PubOpts is the aggregated options.
No description provided by the author
RelayPubSubCollector .
No description provided by the author
No description provided by the author

# Interfaces

Logger .
Profile stores query profiles.
PubSubCollector is a group communication module on topic-based overlay network.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

FinalRespHandler is the callback function when the root node receiving a response.
InitOpt is options used in NewBasicPubSubCollector.
Intermediate type alias.
JoinOpt is optional options in PubSubCollector.Join.
Message is type alias.
MsgHandler .
ProfileFactory generates a Profile.
PubOpt is optional options in PubSubCollector.Publish.
PubSubFactory initializes a pubsub in Topics.
ReqIDFn is used to generate id for each request.
Request type alias.
RequestHandler is the callback function when receiving a request.
RequestID type alias.
Response type alias.
TopicHandle is the handle function of subscription.
TopicMsgHandler .
TopicOpt is the option in NewTopics.
TopicWireListener .