status-im/go-libp2p-pubsub
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

improve godocs

Browse Source
This commit is contained in:
vyzo 2019-05-14 13:57:44 +03:00
parent cb423f474d
commit f4d9eeec26
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
validation.go
View File

@ -20,7 +20,14 @@ type Validator func(context.Context, peer.ID, *Message) bool
// ValidatorOpt is an option for RegisterTopicValidator. // ValidatorOpt is an option for RegisterTopicValidator.
type ValidatorOpt func(addVal *addValReq) error type ValidatorOpt func(addVal *addValReq) error
// validation represents the validator pipeline // validation represents the validator pipeline.
// The validator pipeline performs signature validation and runs a
// sequence of user-configured validators per-topic. It is possible to
// adjust various concurrency parameters, such as the number of
// workers and the max number of simultaneous validations. The user
// can also attach inline validators that will be executed
// synchronously; this may be useful to prevent superfluous
// context-switching for lightweight tasks.
type validation struct { type validation struct {
p *PubSub p *PubSub
@ -344,6 +351,10 @@ func WithValidateThrottle(n int) Option {
// WithValidateWorkers sets the number of synchronous validation worker goroutines. // WithValidateWorkers sets the number of synchronous validation worker goroutines.
// Defaults to NumCPU. // Defaults to NumCPU.
//
// The synchronous validation workers perform signature validation, apply inline
// user validators, and schedule asynchronous user validators.
// You can adjust this parameter to devote less cpu time to synchronous validation.
func WithValidateWorkers(n int) Option { func WithValidateWorkers(n int) Option {
return func(ps *PubSub) error { return func(ps *PubSub) error {
if n > 0 { if n > 0 {