store

Nov 14, 2023

Changes in this version

+ const StoreENRField

type HistoryRequestOption

+ func WithPeerAddr(pAddr multiaddr.Multiaddr) HistoryRequestOption

type Query

+ PubsubTopic string

Sep 17, 2023

Changes in this version

+ var ErrInvalidID = errors.New("invalid request id")

type HistoryRequestOption

+ func WithAutomaticRequestID() HistoryRequestOption

+ func WithRequestID(requestID []byte) HistoryRequestOption

+ type Metrics interface

+ RecordError func(err metricsErrCategory)

+ RecordQuery func()

May 12, 2023

Changes in this version

type MessageProvider

+ Validate func(env *protocol.Envelope) error

type Store

+ SetHost func(h host.Host)

type WakuStore

+ func (store *WakuStore) SetHost(h host.Host)

Feb 17, 2023

Changes in this version

type HistoryRequestOption

+ func WithLocalQuery() HistoryRequestOption

Jan 23, 2023

Changes in this version

type Result

+ func (r *Result) GetMessages() []*pb.WakuMessage

+ func (r *Result) Next(ctx context.Context) (bool, error)

+ type WakuSwap interface

Dec 21, 2022

Changes in this version

+ const MaxContentFilters

+ const MaxPageSize

+ const MaxTimeVariance

+ const StoreID_v20beta4

+ var ErrEmptyResponse = errors.New("empty store response")

+ var ErrFailedQuery = errors.New("failed to resolve the query")

+ var ErrFailedToResumeHistory = errors.New("failed to resume the history")

+ var ErrFutureMessage = errors.New("message timestamp in the future")

+ var ErrInvalidId = errors.New("invalid request id")

+ var ErrMaxContentFilters = errors.New("exceeds the maximum number of content filters allowed")

+ var ErrNoPeersAvailable = errors.New("no suitable remote peers")

+ type HistoryRequestOption func(*HistoryRequestParameters)

+ func DefaultOptions() []HistoryRequestOption

+ func WithAutomaticPeerSelection(fromThesePeers ...peer.ID) HistoryRequestOption

+ func WithAutomaticRequestId() HistoryRequestOption

+ func WithCursor(c *pb.Index) HistoryRequestOption

+ func WithFastestPeerSelection(ctx context.Context, fromThesePeers ...peer.ID) HistoryRequestOption

+ func WithPaging(asc bool, pageSize uint64) HistoryRequestOption

+ func WithPeer(p peer.ID) HistoryRequestOption

+ func WithRequestId(requestId []byte) HistoryRequestOption

+ type HistoryRequestParameters struct

+ type MessageProvider interface

+ Count func() (int, error)

+ GetAll func() ([]persistence.StoredMessage, error)

+ MostRecentTimestamp func() (int64, error)

+ Put func(env *protocol.Envelope) error

+ Query func(query *pb.HistoryQuery) (*pb.Index, []persistence.StoredMessage, error)

+ Start func(timesource timesource.Timesource) error

+ Stop func()

+ type Query struct

+ ContentTopics []string

+ EndTime int64

+ StartTime int64

+ Topic string

+ type Result struct

+ Messages []*pb.WakuMessage

+ func (r *Result) Cursor() *pb.Index

+ func (r *Result) IsComplete() bool

+ func (r *Result) PeerID() peer.ID

+ func (r *Result) Query() *pb.HistoryQuery

+ type Store interface

+ Find func(ctx context.Context, query Query, cb criteriaFN, opts ...HistoryRequestOption) (*pb.WakuMessage, error)

+ MessageChannel func() chan *protocol.Envelope

+ Next func(ctx context.Context, r *Result) (*Result, error)

+ Query func(ctx context.Context, query Query, opts ...HistoryRequestOption) (*Result, error)

+ Resume func(ctx context.Context, pubsubTopic string, peerList []peer.ID) (int, error)

+ Start func(ctx context.Context) error

+ Stop func()

+ type WakuStore struct

+ MsgC chan *protocol.Envelope

+ func NewWakuStore(host host.Host, swap *swap.WakuSwap, p MessageProvider, ...) *WakuStore

+ func (store *WakuStore) Find(ctx context.Context, query Query, cb criteriaFN, opts ...HistoryRequestOption) (*pb.WakuMessage, error)

+ func (store *WakuStore) FindMessages(query *pb.HistoryQuery) *pb.HistoryResponse

+ func (store *WakuStore) MessageChannel() chan *protocol.Envelope

+ func (store *WakuStore) Next(ctx context.Context, r *Result) (*Result, error)

+ func (store *WakuStore) Query(ctx context.Context, query Query, opts ...HistoryRequestOption) (*Result, error)

+ func (store *WakuStore) Resume(ctx context.Context, pubsubTopic string, peerList []peer.ID) (int, error)

+ func (store *WakuStore) SetMessageProvider(p MessageProvider)

+ func (store *WakuStore) Start(ctx context.Context) error

+ func (store *WakuStore) Stop()