pubsub

Documentation

Index

• Constants
• Variables
• type AddAddresses
• type Command
  • func (c *Command) String() string
• type Filter
• type FilterParam
  • func NewFilterParam() *FilterParam
  • func (f *FilterParam) Add(bl ...[]byte) error
  • func (f *FilterParam) Check(addr []byte) bool
  • func (f *FilterParam) Filter() bloom.Filter
  • func (f *FilterParam) Len() int
  • func (f *FilterParam) NewSet()
  • func (f *FilterParam) SetFilter(filter bloom.Filter) bloom.Filter
• type Filterer
• type NewBloom
  • func (c *NewBloom) IsParamsValid() bool
• type NewSet
• type Server
  • func New(networkID uint32, log logging.Logger) *Server
  • func (s *Server) Publish(parser Filterer)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const (

	// MaxBytes the max number of bytes for a filter
	MaxBytes = 1 * units.MiB

	// MaxAddresses the max number of addresses allowed
	MaxAddresses = 10000
)

Variables

var (
	ErrFilterNotInitialized = errors.New("filter not initialized")
	ErrAddressLimit         = errors.New("address limit exceeded")
	ErrInvalidFilterParam   = errors.New("invalid bloom filter params")
	ErrInvalidCommand       = errors.New("invalid command")
)

Types

type AddAddresses

type AddAddresses struct {
	api.JSONAddresses
	// contains filtered or unexported fields
}

AddAddresses command to add addresses

type Command

type Command struct {
	NewBloom     *NewBloom     `json:"newBloom,omitempty"`
	NewSet       *NewSet       `json:"newSet,omitempty"`
	AddAddresses *AddAddresses `json:"addAddresses,omitempty"`
}

Command execution command

func (*Command) String

func (c *Command) String() string

type Filter

type Filter interface {
	Check(addr []byte) bool
}

type FilterParam

type FilterParam struct {
	// contains filtered or unexported fields
}

func NewFilterParam

func NewFilterParam() *FilterParam

func (*FilterParam) Add

func (f *FilterParam) Add(bl ...[]byte) error

func (*FilterParam) Check

func (f *FilterParam) Check(addr []byte) bool

func (*FilterParam) Filter

func (f *FilterParam) Filter() bloom.Filter

func (*FilterParam) Len

func (f *FilterParam) Len() int

func (*FilterParam) NewSet

func (f *FilterParam) NewSet()

func (*FilterParam) SetFilter

func (f *FilterParam) SetFilter(filter bloom.Filter) bloom.Filter

type Filterer

type Filterer interface {
	Filter(connections []Filter) ([]bool, interface{})
}

type NewBloom

type NewBloom struct {
	// MaxElements size of bloom filter
	MaxElements json.Uint64 `json:"maxElements"`
	// CollisionProb expected error rate of filter
	CollisionProb json.Float64 `json:"collisionProb"`
}

NewBloom command for a new bloom filter

func (*NewBloom) IsParamsValid

func (c *NewBloom) IsParamsValid() bool

type NewSet

type NewSet struct{}

NewSet command for a new map set

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server maintains the set of active clients and sends messages to the clients.

func New

func New(networkID uint32, log logging.Logger) *Server

func (*Server) Publish

func (s *Server) Publish(parser Filterer)

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)