pubsub

package module

v1.0.2 Latest Latest Go to latest Published: Jun 5, 2026 License: BSD-3-Clause Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luxfi/pubsub

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type AddAddressesdeprecated
type Commanddeprecated
- 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 Float64
- func (f Float64) MarshalJSON() ([]byte, error)
- func (f *Float64) UnmarshalJSON(b []byte) error
type NewBloomdeprecated
- func (c *NewBloom) IsParamsValid() bool
type NewSetdeprecated
type Server
- func New(log log.Logger) *Serverdeprecated
- func (s *Server) Publish(parser Filterer)
- func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
type Uint64
- func (u Uint64) MarshalJSON() ([]byte, error)
- func (u *Uint64) UnmarshalJSON(b []byte) error

Constants ¶

View Source

const (

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

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

Variables ¶

View Source

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")
)

Functions ¶

This section is empty.

Types ¶

type AddAddresses deprecated

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

AddAddresses command to add addresses

Deprecated: The pubsub server is deprecated.

type Command deprecated

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

Command execution command

Deprecated: The pubsub server is deprecated.

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 Float64 ¶

type Float64 float64

Float64 is a float64 that JSON marshals as a quoted decimal string.

func (Float64) MarshalJSON ¶

func (f Float64) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*Float64) UnmarshalJSON ¶

func (f *Float64) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type NewBloom deprecated

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

NewBloom command for a new bloom filter

Deprecated: The pubsub server is deprecated.

func (*NewBloom) IsParamsValid ¶

func (c *NewBloom) IsParamsValid() bool

type NewSet deprecated

type NewSet struct{}

NewSet command for a new map set

Deprecated: The pubsub server is deprecated.

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 deprecated

func New(log log.Logger) *Server

Deprecated: The pubsub server is deprecated.

func (*Server) Publish ¶

func (s *Server) Publish(parser Filterer)

func (*Server) ServeHTTP ¶

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

type Uint64 ¶

type Uint64 uint64

Uint64 is a uint64 that JSON marshals as a quoted decimal string. Used at the JSON-RPC boundary where JS clients lose precision on integers > 2^53.

func (Uint64) MarshalJSON ¶

func (u Uint64) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*Uint64) UnmarshalJSON ¶

func (u *Uint64) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
bloom

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL